whop_sdk 0.0.32 → 0.0.33
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 +9 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +5 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +14 -1
- data/lib/whop_sdk/models/payout_account_calculated_statuses.rb +21 -0
- data/lib/whop_sdk/models/payout_account_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/payout_account_retrieve_response.rb +223 -0
- data/lib/whop_sdk/models/payout_account_status_updated_webhook_event.rb +275 -0
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +3 -1
- data/lib/whop_sdk/models/verification_list_params.rb +54 -0
- data/lib/whop_sdk/models/verification_list_response.rb +48 -0
- data/lib/whop_sdk/models/webhook_event.rb +1 -0
- data/lib/whop_sdk/models.rb +8 -0
- data/lib/whop_sdk/resources/payout_accounts.rb +39 -0
- data/lib/whop_sdk/resources/verifications.rb +37 -0
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +7 -0
- data/rbi/whop_sdk/client.rbi +4 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +21 -3
- data/rbi/whop_sdk/models/payout_account_calculated_statuses.rbi +51 -0
- data/rbi/whop_sdk/models/payout_account_retrieve_params.rbi +38 -0
- data/rbi/whop_sdk/models/payout_account_retrieve_response.rbi +370 -0
- data/rbi/whop_sdk/models/payout_account_status_updated_webhook_event.rbi +459 -0
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +1 -0
- data/rbi/whop_sdk/models/verification_list_params.rbi +75 -0
- data/rbi/whop_sdk/models/verification_list_response.rbi +69 -0
- data/rbi/whop_sdk/models/webhook_event.rbi +5 -0
- data/rbi/whop_sdk/models.rbi +10 -0
- data/rbi/whop_sdk/resources/payout_accounts.rbi +31 -0
- data/rbi/whop_sdk/resources/verifications.rbi +35 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +1 -0
- data/sig/whop_sdk/client.rbs +2 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +8 -3
- data/sig/whop_sdk/models/payout_account_calculated_statuses.rbs +24 -0
- data/sig/whop_sdk/models/payout_account_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/payout_account_retrieve_response.rbs +161 -0
- data/sig/whop_sdk/models/payout_account_status_updated_webhook_event.rbs +203 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +1 -0
- data/sig/whop_sdk/models/verification_list_params.rbs +46 -0
- data/sig/whop_sdk/models/verification_list_response.rbs +35 -0
- data/sig/whop_sdk/models/webhook_event.rbs +2 -0
- data/sig/whop_sdk/models.rbs +8 -0
- data/sig/whop_sdk/resources/payout_accounts.rbs +12 -0
- data/sig/whop_sdk/resources/verifications.rbs +9 -0
- data/sig/whop_sdk/resources/webhooks.rbs +1 -0
- metadata +23 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 28f835aae058932c3301ee606eb668a48756fa8968a0f64b5c752a5908aa901c
|
|
4
|
+
data.tar.gz: 2d76373bb6ec201208f5cb90f6e8a853accdfb4c458b72fc880d63b0de03dd2f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c1a0d4467a47b7a2291f061a38fd4d098257644c9aa69f32b101ab8a24126b04574bafc6770fed89b80b7f4de4059e0bb060b95b513570cfac35e3a556259cde
|
|
7
|
+
data.tar.gz: e1f86b42f9bb8e3f5a4b25a80159071bc8731328215c8787359a9d86120d62a8d19827055313a5f5d7e73ff28da502fb52aff9a451fe5e264b78015b16e9c77e
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.0.33 (2026-03-12)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.0.32...v0.0.33](https://github.com/whopio/whopsdk-ruby/compare/v0.0.32...v0.0.33)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([e9bdc24](https://github.com/whopio/whopsdk-ruby/commit/e9bdc24914a094959bb450165e5c7c261cf0063e))
|
|
10
|
+
* **api:** manual updates ([a0a3ca0](https://github.com/whopio/whopsdk-ruby/commit/a0a3ca0022cdeed9b42b5b00a7d4e2f57ae4248b))
|
|
11
|
+
|
|
3
12
|
## 0.0.32 (2026-03-11)
|
|
4
13
|
|
|
5
14
|
Full Changelog: [v0.0.31...v0.0.32](https://github.com/whopio/whopsdk-ruby/compare/v0.0.31...v0.0.32)
|
data/README.md
CHANGED
data/lib/whop_sdk/client.rb
CHANGED
|
@@ -233,6 +233,10 @@ module WhopSDK
|
|
|
233
233
|
# @return [WhopSDK::Resources::ResolutionCenterCases]
|
|
234
234
|
attr_reader :resolution_center_cases
|
|
235
235
|
|
|
236
|
+
# Payout accounts
|
|
237
|
+
# @return [WhopSDK::Resources::PayoutAccounts]
|
|
238
|
+
attr_reader :payout_accounts
|
|
239
|
+
|
|
236
240
|
# @api private
|
|
237
241
|
#
|
|
238
242
|
# @return [Hash{String=>String}]
|
|
@@ -346,6 +350,7 @@ module WhopSDK
|
|
|
346
350
|
@dm_channels = WhopSDK::Resources::DmChannels.new(client: self)
|
|
347
351
|
@dispute_alerts = WhopSDK::Resources::DisputeAlerts.new(client: self)
|
|
348
352
|
@resolution_center_cases = WhopSDK::Resources::ResolutionCenterCases.new(client: self)
|
|
353
|
+
@payout_accounts = WhopSDK::Resources::PayoutAccounts.new(client: self)
|
|
349
354
|
end
|
|
350
355
|
|
|
351
356
|
# Verifies a Whop user token
|
|
@@ -282,7 +282,18 @@ module WhopSDK
|
|
|
282
282
|
# @return [String, nil]
|
|
283
283
|
required :phone, String, nil?: true
|
|
284
284
|
|
|
285
|
-
# @!
|
|
285
|
+
# @!attribute status
|
|
286
|
+
# The granular calculated statuses reflecting payout account KYC and withdrawal
|
|
287
|
+
# readiness.
|
|
288
|
+
#
|
|
289
|
+
# @return [Symbol, WhopSDK::Models::PayoutAccountCalculatedStatuses, nil]
|
|
290
|
+
required :status, enum: -> { WhopSDK::PayoutAccountCalculatedStatuses }, nil?: true
|
|
291
|
+
|
|
292
|
+
# @!method initialize(id:, address:, business_name:, business_representative:, email:, latest_verification:, phone:, status:)
|
|
293
|
+
# Some parameter documentations has been truncated, see
|
|
294
|
+
# {WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails} for more
|
|
295
|
+
# details.
|
|
296
|
+
#
|
|
286
297
|
# The payout account associated with the LedgerAccount, if any.
|
|
287
298
|
#
|
|
288
299
|
# @param id [String] The unique identifier for the payout account.
|
|
@@ -298,6 +309,8 @@ module WhopSDK
|
|
|
298
309
|
# @param latest_verification [WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails::LatestVerification, nil] The latest verification for the connected account.
|
|
299
310
|
#
|
|
300
311
|
# @param phone [String, nil] The business representative's phone
|
|
312
|
+
#
|
|
313
|
+
# @param status [Symbol, WhopSDK::Models::PayoutAccountCalculatedStatuses, nil] The granular calculated statuses reflecting payout account KYC and withdrawal re
|
|
301
314
|
|
|
302
315
|
# @see WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails#address
|
|
303
316
|
class Address < WhopSDK::Internal::Type::BaseModel
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# The granular calculated statuses reflecting payout account KYC and withdrawal
|
|
6
|
+
# readiness.
|
|
7
|
+
module PayoutAccountCalculatedStatuses
|
|
8
|
+
extend WhopSDK::Internal::Type::Enum
|
|
9
|
+
|
|
10
|
+
CONNECTED = :connected
|
|
11
|
+
DISABLED = :disabled
|
|
12
|
+
ACTION_REQUIRED = :action_required
|
|
13
|
+
PENDING_VERIFICATION = :pending_verification
|
|
14
|
+
VERIFICATION_FAILED = :verification_failed
|
|
15
|
+
NOT_STARTED = :not_started
|
|
16
|
+
|
|
17
|
+
# @!method self.values
|
|
18
|
+
# @return [Array<Symbol>]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::PayoutAccounts#retrieve
|
|
6
|
+
class PayoutAccountRetrieveParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(id:, request_options: {})
|
|
16
|
+
# @param id [String]
|
|
17
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::PayoutAccounts#retrieve
|
|
6
|
+
class PayoutAccountRetrieveResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique identifier for the payout account.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute address
|
|
14
|
+
# The physical address associated with this payout account
|
|
15
|
+
#
|
|
16
|
+
# @return [WhopSDK::Models::PayoutAccountRetrieveResponse::Address, nil]
|
|
17
|
+
required :address, -> { WhopSDK::Models::PayoutAccountRetrieveResponse::Address }, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute business_name
|
|
20
|
+
# The company's legal name
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
required :business_name, String, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!attribute business_representative
|
|
26
|
+
# The business representative for this payout account
|
|
27
|
+
#
|
|
28
|
+
# @return [WhopSDK::Models::PayoutAccountRetrieveResponse::BusinessRepresentative, nil]
|
|
29
|
+
required :business_representative,
|
|
30
|
+
-> { WhopSDK::Models::PayoutAccountRetrieveResponse::BusinessRepresentative },
|
|
31
|
+
nil?: true
|
|
32
|
+
|
|
33
|
+
# @!attribute email
|
|
34
|
+
# The email address of the representative
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
required :email, String, nil?: true
|
|
38
|
+
|
|
39
|
+
# @!attribute latest_verification
|
|
40
|
+
# The latest verification for the connected account.
|
|
41
|
+
#
|
|
42
|
+
# @return [WhopSDK::Models::PayoutAccountRetrieveResponse::LatestVerification, nil]
|
|
43
|
+
required :latest_verification,
|
|
44
|
+
-> { WhopSDK::Models::PayoutAccountRetrieveResponse::LatestVerification },
|
|
45
|
+
nil?: true
|
|
46
|
+
|
|
47
|
+
# @!attribute phone
|
|
48
|
+
# The business representative's phone
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
required :phone, String, nil?: true
|
|
52
|
+
|
|
53
|
+
# @!attribute status
|
|
54
|
+
# The granular calculated statuses reflecting payout account KYC and withdrawal
|
|
55
|
+
# readiness.
|
|
56
|
+
#
|
|
57
|
+
# @return [Symbol, WhopSDK::Models::PayoutAccountCalculatedStatuses, nil]
|
|
58
|
+
required :status, enum: -> { WhopSDK::PayoutAccountCalculatedStatuses }, nil?: true
|
|
59
|
+
|
|
60
|
+
# @!method initialize(id:, address:, business_name:, business_representative:, email:, latest_verification:, phone:, status:)
|
|
61
|
+
# Some parameter documentations has been truncated, see
|
|
62
|
+
# {WhopSDK::Models::PayoutAccountRetrieveResponse} for more details.
|
|
63
|
+
#
|
|
64
|
+
# An object representing an account used for payouts.
|
|
65
|
+
#
|
|
66
|
+
# @param id [String] The unique identifier for the payout account.
|
|
67
|
+
#
|
|
68
|
+
# @param address [WhopSDK::Models::PayoutAccountRetrieveResponse::Address, nil] The physical address associated with this payout account
|
|
69
|
+
#
|
|
70
|
+
# @param business_name [String, nil] The company's legal name
|
|
71
|
+
#
|
|
72
|
+
# @param business_representative [WhopSDK::Models::PayoutAccountRetrieveResponse::BusinessRepresentative, nil] The business representative for this payout account
|
|
73
|
+
#
|
|
74
|
+
# @param email [String, nil] The email address of the representative
|
|
75
|
+
#
|
|
76
|
+
# @param latest_verification [WhopSDK::Models::PayoutAccountRetrieveResponse::LatestVerification, nil] The latest verification for the connected account.
|
|
77
|
+
#
|
|
78
|
+
# @param phone [String, nil] The business representative's phone
|
|
79
|
+
#
|
|
80
|
+
# @param status [Symbol, WhopSDK::Models::PayoutAccountCalculatedStatuses, nil] The granular calculated statuses reflecting payout account KYC and withdrawal re
|
|
81
|
+
|
|
82
|
+
# @see WhopSDK::Models::PayoutAccountRetrieveResponse#address
|
|
83
|
+
class Address < WhopSDK::Internal::Type::BaseModel
|
|
84
|
+
# @!attribute city
|
|
85
|
+
# The city of the address.
|
|
86
|
+
#
|
|
87
|
+
# @return [String, nil]
|
|
88
|
+
required :city, String, nil?: true
|
|
89
|
+
|
|
90
|
+
# @!attribute country
|
|
91
|
+
# The country of the address.
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
required :country, String, nil?: true
|
|
95
|
+
|
|
96
|
+
# @!attribute line1
|
|
97
|
+
# The line 1 of the address.
|
|
98
|
+
#
|
|
99
|
+
# @return [String, nil]
|
|
100
|
+
required :line1, String, nil?: true
|
|
101
|
+
|
|
102
|
+
# @!attribute line2
|
|
103
|
+
# The line 2 of the address.
|
|
104
|
+
#
|
|
105
|
+
# @return [String, nil]
|
|
106
|
+
required :line2, String, nil?: true
|
|
107
|
+
|
|
108
|
+
# @!attribute postal_code
|
|
109
|
+
# The postal code of the address.
|
|
110
|
+
#
|
|
111
|
+
# @return [String, nil]
|
|
112
|
+
required :postal_code, String, nil?: true
|
|
113
|
+
|
|
114
|
+
# @!attribute state
|
|
115
|
+
# The state of the address.
|
|
116
|
+
#
|
|
117
|
+
# @return [String, nil]
|
|
118
|
+
required :state, String, nil?: true
|
|
119
|
+
|
|
120
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
|
121
|
+
# The physical address associated with this payout account
|
|
122
|
+
#
|
|
123
|
+
# @param city [String, nil] The city of the address.
|
|
124
|
+
#
|
|
125
|
+
# @param country [String, nil] The country of the address.
|
|
126
|
+
#
|
|
127
|
+
# @param line1 [String, nil] The line 1 of the address.
|
|
128
|
+
#
|
|
129
|
+
# @param line2 [String, nil] The line 2 of the address.
|
|
130
|
+
#
|
|
131
|
+
# @param postal_code [String, nil] The postal code of the address.
|
|
132
|
+
#
|
|
133
|
+
# @param state [String, nil] The state of the address.
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# @see WhopSDK::Models::PayoutAccountRetrieveResponse#business_representative
|
|
137
|
+
class BusinessRepresentative < WhopSDK::Internal::Type::BaseModel
|
|
138
|
+
# @!attribute date_of_birth
|
|
139
|
+
# The date of birth of the business representative in ISO 8601 format
|
|
140
|
+
# (YYYY-MM-DD).
|
|
141
|
+
#
|
|
142
|
+
# @return [String, nil]
|
|
143
|
+
required :date_of_birth, String, nil?: true
|
|
144
|
+
|
|
145
|
+
# @!attribute first_name
|
|
146
|
+
# The first name of the business representative.
|
|
147
|
+
#
|
|
148
|
+
# @return [String, nil]
|
|
149
|
+
required :first_name, String, nil?: true
|
|
150
|
+
|
|
151
|
+
# @!attribute last_name
|
|
152
|
+
# The last name of the business representative.
|
|
153
|
+
#
|
|
154
|
+
# @return [String, nil]
|
|
155
|
+
required :last_name, String, nil?: true
|
|
156
|
+
|
|
157
|
+
# @!attribute middle_name
|
|
158
|
+
# The middle name of the business representative.
|
|
159
|
+
#
|
|
160
|
+
# @return [String, nil]
|
|
161
|
+
required :middle_name, String, nil?: true
|
|
162
|
+
|
|
163
|
+
# @!method initialize(date_of_birth:, first_name:, last_name:, middle_name:)
|
|
164
|
+
# Some parameter documentations has been truncated, see
|
|
165
|
+
# {WhopSDK::Models::PayoutAccountRetrieveResponse::BusinessRepresentative} for
|
|
166
|
+
# more details.
|
|
167
|
+
#
|
|
168
|
+
# The business representative for this payout account
|
|
169
|
+
#
|
|
170
|
+
# @param date_of_birth [String, nil] The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD)
|
|
171
|
+
#
|
|
172
|
+
# @param first_name [String, nil] The first name of the business representative.
|
|
173
|
+
#
|
|
174
|
+
# @param last_name [String, nil] The last name of the business representative.
|
|
175
|
+
#
|
|
176
|
+
# @param middle_name [String, nil] The middle name of the business representative.
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# @see WhopSDK::Models::PayoutAccountRetrieveResponse#latest_verification
|
|
180
|
+
class LatestVerification < WhopSDK::Internal::Type::BaseModel
|
|
181
|
+
# @!attribute id
|
|
182
|
+
# The unique identifier for the verification.
|
|
183
|
+
#
|
|
184
|
+
# @return [String]
|
|
185
|
+
required :id, String
|
|
186
|
+
|
|
187
|
+
# @!attribute last_error_code
|
|
188
|
+
# An error code for a verification attempt.
|
|
189
|
+
#
|
|
190
|
+
# @return [Symbol, WhopSDK::Models::VerificationErrorCode, nil]
|
|
191
|
+
required :last_error_code, enum: -> { WhopSDK::VerificationErrorCode }, nil?: true
|
|
192
|
+
|
|
193
|
+
# @!attribute last_error_reason
|
|
194
|
+
# A human-readable explanation of the most recent verification error. Null if no
|
|
195
|
+
# error has occurred.
|
|
196
|
+
#
|
|
197
|
+
# @return [String, nil]
|
|
198
|
+
required :last_error_reason, String, nil?: true
|
|
199
|
+
|
|
200
|
+
# @!attribute status
|
|
201
|
+
# The current status of this verification session.
|
|
202
|
+
#
|
|
203
|
+
# @return [Symbol, WhopSDK::Models::VerificationStatus]
|
|
204
|
+
required :status, enum: -> { WhopSDK::VerificationStatus }
|
|
205
|
+
|
|
206
|
+
# @!method initialize(id:, last_error_code:, last_error_reason:, status:)
|
|
207
|
+
# Some parameter documentations has been truncated, see
|
|
208
|
+
# {WhopSDK::Models::PayoutAccountRetrieveResponse::LatestVerification} for more
|
|
209
|
+
# details.
|
|
210
|
+
#
|
|
211
|
+
# The latest verification for the connected account.
|
|
212
|
+
#
|
|
213
|
+
# @param id [String] The unique identifier for the verification.
|
|
214
|
+
#
|
|
215
|
+
# @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
|
|
216
|
+
#
|
|
217
|
+
# @param last_error_reason [String, nil] A human-readable explanation of the most recent verification error. Null if no e
|
|
218
|
+
#
|
|
219
|
+
# @param status [Symbol, WhopSDK::Models::VerificationStatus] The current status of this verification session.
|
|
220
|
+
end
|
|
221
|
+
end
|
|
222
|
+
end
|
|
223
|
+
end
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class PayoutAccountStatusUpdatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# A unique ID for every single webhook request
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute api_version
|
|
13
|
+
# The API version for this webhook
|
|
14
|
+
#
|
|
15
|
+
# @return [Symbol, :v1]
|
|
16
|
+
required :api_version, const: :v1
|
|
17
|
+
|
|
18
|
+
# @!attribute data
|
|
19
|
+
# An object representing an account used for payouts.
|
|
20
|
+
#
|
|
21
|
+
# @return [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data]
|
|
22
|
+
required :data, -> { WhopSDK::PayoutAccountStatusUpdatedWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute timestamp
|
|
25
|
+
# The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
26
|
+
#
|
|
27
|
+
# @return [Time]
|
|
28
|
+
required :timestamp, Time
|
|
29
|
+
|
|
30
|
+
# @!attribute type
|
|
31
|
+
# The webhook event type
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, :"payout_account.status_updated"]
|
|
34
|
+
required :type, const: :"payout_account.status_updated"
|
|
35
|
+
|
|
36
|
+
# @!attribute company_id
|
|
37
|
+
# The company ID that this webhook event is associated with
|
|
38
|
+
#
|
|
39
|
+
# @return [String, nil]
|
|
40
|
+
optional :company_id, String, nil?: true
|
|
41
|
+
|
|
42
|
+
# @!method initialize(id:, data:, timestamp:, company_id: nil, api_version: :v1, type: :"payout_account.status_updated")
|
|
43
|
+
# @param id [String] A unique ID for every single webhook request
|
|
44
|
+
#
|
|
45
|
+
# @param data [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data] An object representing an account used for payouts.
|
|
46
|
+
#
|
|
47
|
+
# @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
48
|
+
#
|
|
49
|
+
# @param company_id [String, nil] The company ID that this webhook event is associated with
|
|
50
|
+
#
|
|
51
|
+
# @param api_version [Symbol, :v1] The API version for this webhook
|
|
52
|
+
#
|
|
53
|
+
# @param type [Symbol, :"payout_account.status_updated"] The webhook event type
|
|
54
|
+
|
|
55
|
+
# @see WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent#data
|
|
56
|
+
class Data < WhopSDK::Internal::Type::BaseModel
|
|
57
|
+
# @!attribute id
|
|
58
|
+
# The unique identifier for the payout account.
|
|
59
|
+
#
|
|
60
|
+
# @return [String]
|
|
61
|
+
required :id, String
|
|
62
|
+
|
|
63
|
+
# @!attribute address
|
|
64
|
+
# The physical address associated with this payout account
|
|
65
|
+
#
|
|
66
|
+
# @return [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::Address, nil]
|
|
67
|
+
required :address, -> { WhopSDK::PayoutAccountStatusUpdatedWebhookEvent::Data::Address }, nil?: true
|
|
68
|
+
|
|
69
|
+
# @!attribute business_name
|
|
70
|
+
# The company's legal name
|
|
71
|
+
#
|
|
72
|
+
# @return [String, nil]
|
|
73
|
+
required :business_name, String, nil?: true
|
|
74
|
+
|
|
75
|
+
# @!attribute business_representative
|
|
76
|
+
# The business representative for this payout account
|
|
77
|
+
#
|
|
78
|
+
# @return [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::BusinessRepresentative, nil]
|
|
79
|
+
required :business_representative,
|
|
80
|
+
-> { WhopSDK::PayoutAccountStatusUpdatedWebhookEvent::Data::BusinessRepresentative },
|
|
81
|
+
nil?: true
|
|
82
|
+
|
|
83
|
+
# @!attribute email
|
|
84
|
+
# The email address of the representative
|
|
85
|
+
#
|
|
86
|
+
# @return [String, nil]
|
|
87
|
+
required :email, String, nil?: true
|
|
88
|
+
|
|
89
|
+
# @!attribute latest_verification
|
|
90
|
+
# The latest verification for the connected account.
|
|
91
|
+
#
|
|
92
|
+
# @return [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::LatestVerification, nil]
|
|
93
|
+
required :latest_verification,
|
|
94
|
+
-> { WhopSDK::PayoutAccountStatusUpdatedWebhookEvent::Data::LatestVerification },
|
|
95
|
+
nil?: true
|
|
96
|
+
|
|
97
|
+
# @!attribute phone
|
|
98
|
+
# The business representative's phone
|
|
99
|
+
#
|
|
100
|
+
# @return [String, nil]
|
|
101
|
+
required :phone, String, nil?: true
|
|
102
|
+
|
|
103
|
+
# @!attribute status
|
|
104
|
+
# The granular calculated statuses reflecting payout account KYC and withdrawal
|
|
105
|
+
# readiness.
|
|
106
|
+
#
|
|
107
|
+
# @return [Symbol, WhopSDK::Models::PayoutAccountCalculatedStatuses, nil]
|
|
108
|
+
required :status, enum: -> { WhopSDK::PayoutAccountCalculatedStatuses }, nil?: true
|
|
109
|
+
|
|
110
|
+
# @!method initialize(id:, address:, business_name:, business_representative:, email:, latest_verification:, phone:, status:)
|
|
111
|
+
# Some parameter documentations has been truncated, see
|
|
112
|
+
# {WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data} for more
|
|
113
|
+
# details.
|
|
114
|
+
#
|
|
115
|
+
# An object representing an account used for payouts.
|
|
116
|
+
#
|
|
117
|
+
# @param id [String] The unique identifier for the payout account.
|
|
118
|
+
#
|
|
119
|
+
# @param address [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::Address, nil] The physical address associated with this payout account
|
|
120
|
+
#
|
|
121
|
+
# @param business_name [String, nil] The company's legal name
|
|
122
|
+
#
|
|
123
|
+
# @param business_representative [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::BusinessRepresentative, nil] The business representative for this payout account
|
|
124
|
+
#
|
|
125
|
+
# @param email [String, nil] The email address of the representative
|
|
126
|
+
#
|
|
127
|
+
# @param latest_verification [WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::LatestVerification, nil] The latest verification for the connected account.
|
|
128
|
+
#
|
|
129
|
+
# @param phone [String, nil] The business representative's phone
|
|
130
|
+
#
|
|
131
|
+
# @param status [Symbol, WhopSDK::Models::PayoutAccountCalculatedStatuses, nil] The granular calculated statuses reflecting payout account KYC and withdrawal re
|
|
132
|
+
|
|
133
|
+
# @see WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data#address
|
|
134
|
+
class Address < WhopSDK::Internal::Type::BaseModel
|
|
135
|
+
# @!attribute city
|
|
136
|
+
# The city of the address.
|
|
137
|
+
#
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
required :city, String, nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute country
|
|
142
|
+
# The country of the address.
|
|
143
|
+
#
|
|
144
|
+
# @return [String, nil]
|
|
145
|
+
required :country, String, nil?: true
|
|
146
|
+
|
|
147
|
+
# @!attribute line1
|
|
148
|
+
# The line 1 of the address.
|
|
149
|
+
#
|
|
150
|
+
# @return [String, nil]
|
|
151
|
+
required :line1, String, nil?: true
|
|
152
|
+
|
|
153
|
+
# @!attribute line2
|
|
154
|
+
# The line 2 of the address.
|
|
155
|
+
#
|
|
156
|
+
# @return [String, nil]
|
|
157
|
+
required :line2, String, nil?: true
|
|
158
|
+
|
|
159
|
+
# @!attribute postal_code
|
|
160
|
+
# The postal code of the address.
|
|
161
|
+
#
|
|
162
|
+
# @return [String, nil]
|
|
163
|
+
required :postal_code, String, nil?: true
|
|
164
|
+
|
|
165
|
+
# @!attribute state
|
|
166
|
+
# The state of the address.
|
|
167
|
+
#
|
|
168
|
+
# @return [String, nil]
|
|
169
|
+
required :state, String, nil?: true
|
|
170
|
+
|
|
171
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
|
172
|
+
# The physical address associated with this payout account
|
|
173
|
+
#
|
|
174
|
+
# @param city [String, nil] The city of the address.
|
|
175
|
+
#
|
|
176
|
+
# @param country [String, nil] The country of the address.
|
|
177
|
+
#
|
|
178
|
+
# @param line1 [String, nil] The line 1 of the address.
|
|
179
|
+
#
|
|
180
|
+
# @param line2 [String, nil] The line 2 of the address.
|
|
181
|
+
#
|
|
182
|
+
# @param postal_code [String, nil] The postal code of the address.
|
|
183
|
+
#
|
|
184
|
+
# @param state [String, nil] The state of the address.
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# @see WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data#business_representative
|
|
188
|
+
class BusinessRepresentative < WhopSDK::Internal::Type::BaseModel
|
|
189
|
+
# @!attribute date_of_birth
|
|
190
|
+
# The date of birth of the business representative in ISO 8601 format
|
|
191
|
+
# (YYYY-MM-DD).
|
|
192
|
+
#
|
|
193
|
+
# @return [String, nil]
|
|
194
|
+
required :date_of_birth, String, nil?: true
|
|
195
|
+
|
|
196
|
+
# @!attribute first_name
|
|
197
|
+
# The first name of the business representative.
|
|
198
|
+
#
|
|
199
|
+
# @return [String, nil]
|
|
200
|
+
required :first_name, String, nil?: true
|
|
201
|
+
|
|
202
|
+
# @!attribute last_name
|
|
203
|
+
# The last name of the business representative.
|
|
204
|
+
#
|
|
205
|
+
# @return [String, nil]
|
|
206
|
+
required :last_name, String, nil?: true
|
|
207
|
+
|
|
208
|
+
# @!attribute middle_name
|
|
209
|
+
# The middle name of the business representative.
|
|
210
|
+
#
|
|
211
|
+
# @return [String, nil]
|
|
212
|
+
required :middle_name, String, nil?: true
|
|
213
|
+
|
|
214
|
+
# @!method initialize(date_of_birth:, first_name:, last_name:, middle_name:)
|
|
215
|
+
# Some parameter documentations has been truncated, see
|
|
216
|
+
# {WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::BusinessRepresentative}
|
|
217
|
+
# for more details.
|
|
218
|
+
#
|
|
219
|
+
# The business representative for this payout account
|
|
220
|
+
#
|
|
221
|
+
# @param date_of_birth [String, nil] The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD)
|
|
222
|
+
#
|
|
223
|
+
# @param first_name [String, nil] The first name of the business representative.
|
|
224
|
+
#
|
|
225
|
+
# @param last_name [String, nil] The last name of the business representative.
|
|
226
|
+
#
|
|
227
|
+
# @param middle_name [String, nil] The middle name of the business representative.
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# @see WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data#latest_verification
|
|
231
|
+
class LatestVerification < WhopSDK::Internal::Type::BaseModel
|
|
232
|
+
# @!attribute id
|
|
233
|
+
# The unique identifier for the verification.
|
|
234
|
+
#
|
|
235
|
+
# @return [String]
|
|
236
|
+
required :id, String
|
|
237
|
+
|
|
238
|
+
# @!attribute last_error_code
|
|
239
|
+
# An error code for a verification attempt.
|
|
240
|
+
#
|
|
241
|
+
# @return [Symbol, WhopSDK::Models::VerificationErrorCode, nil]
|
|
242
|
+
required :last_error_code, enum: -> { WhopSDK::VerificationErrorCode }, nil?: true
|
|
243
|
+
|
|
244
|
+
# @!attribute last_error_reason
|
|
245
|
+
# A human-readable explanation of the most recent verification error. Null if no
|
|
246
|
+
# error has occurred.
|
|
247
|
+
#
|
|
248
|
+
# @return [String, nil]
|
|
249
|
+
required :last_error_reason, String, nil?: true
|
|
250
|
+
|
|
251
|
+
# @!attribute status
|
|
252
|
+
# The current status of this verification session.
|
|
253
|
+
#
|
|
254
|
+
# @return [Symbol, WhopSDK::Models::VerificationStatus]
|
|
255
|
+
required :status, enum: -> { WhopSDK::VerificationStatus }
|
|
256
|
+
|
|
257
|
+
# @!method initialize(id:, last_error_code:, last_error_reason:, status:)
|
|
258
|
+
# Some parameter documentations has been truncated, see
|
|
259
|
+
# {WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent::Data::LatestVerification}
|
|
260
|
+
# for more details.
|
|
261
|
+
#
|
|
262
|
+
# The latest verification for the connected account.
|
|
263
|
+
#
|
|
264
|
+
# @param id [String] The unique identifier for the verification.
|
|
265
|
+
#
|
|
266
|
+
# @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
|
|
267
|
+
#
|
|
268
|
+
# @param last_error_reason [String, nil] A human-readable explanation of the most recent verification error. Null if no e
|
|
269
|
+
#
|
|
270
|
+
# @param status [Symbol, WhopSDK::Models::VerificationStatus] The current status of this verification session.
|
|
271
|
+
end
|
|
272
|
+
end
|
|
273
|
+
end
|
|
274
|
+
end
|
|
275
|
+
end
|
|
@@ -44,6 +44,8 @@ module WhopSDK
|
|
|
44
44
|
|
|
45
45
|
variant :"verification.succeeded", -> { WhopSDK::VerificationSucceededWebhookEvent }
|
|
46
46
|
|
|
47
|
+
variant :"payout_account.status_updated", -> { WhopSDK::PayoutAccountStatusUpdatedWebhookEvent }
|
|
48
|
+
|
|
47
49
|
variant :"payment.created", -> { WhopSDK::PaymentCreatedWebhookEvent }
|
|
48
50
|
|
|
49
51
|
variant :"payment.succeeded", -> { WhopSDK::PaymentSucceededWebhookEvent }
|
|
@@ -66,7 +68,7 @@ module WhopSDK
|
|
|
66
68
|
-> { WhopSDK::MembershipCancelAtPeriodEndChangedWebhookEvent }
|
|
67
69
|
|
|
68
70
|
# @!method self.variants
|
|
69
|
-
# @return [Array(WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::SetupIntentRequiresActionWebhookEvent, WhopSDK::Models::SetupIntentSucceededWebhookEvent, WhopSDK::Models::SetupIntentCanceledWebhookEvent, WhopSDK::Models::WithdrawalCreatedWebhookEvent, WhopSDK::Models::WithdrawalUpdatedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PayoutMethodCreatedWebhookEvent, WhopSDK::Models::VerificationSucceededWebhookEvent, WhopSDK::Models::PaymentCreatedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent, WhopSDK::Models::DisputeCreatedWebhookEvent, WhopSDK::Models::DisputeUpdatedWebhookEvent, WhopSDK::Models::RefundCreatedWebhookEvent, WhopSDK::Models::RefundUpdatedWebhookEvent, WhopSDK::Models::DisputeAlertCreatedWebhookEvent, WhopSDK::Models::MembershipCancelAtPeriodEndChangedWebhookEvent)]
|
|
71
|
+
# @return [Array(WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::SetupIntentRequiresActionWebhookEvent, WhopSDK::Models::SetupIntentSucceededWebhookEvent, WhopSDK::Models::SetupIntentCanceledWebhookEvent, WhopSDK::Models::WithdrawalCreatedWebhookEvent, WhopSDK::Models::WithdrawalUpdatedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PayoutMethodCreatedWebhookEvent, WhopSDK::Models::VerificationSucceededWebhookEvent, WhopSDK::Models::PayoutAccountStatusUpdatedWebhookEvent, WhopSDK::Models::PaymentCreatedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent, WhopSDK::Models::DisputeCreatedWebhookEvent, WhopSDK::Models::DisputeUpdatedWebhookEvent, WhopSDK::Models::RefundCreatedWebhookEvent, WhopSDK::Models::RefundUpdatedWebhookEvent, WhopSDK::Models::DisputeAlertCreatedWebhookEvent, WhopSDK::Models::MembershipCancelAtPeriodEndChangedWebhookEvent)]
|
|
70
72
|
end
|
|
71
73
|
end
|
|
72
74
|
end
|