whop_sdk 0.0.12 → 0.0.14
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 +19 -0
- data/README.md +1 -1
- data/lib/whop_sdk/models/company.rb +9 -1
- data/lib/whop_sdk/models/company_create_params.rb +15 -1
- data/lib/whop_sdk/models/company_list_params.rb +2 -2
- data/lib/whop_sdk/models/company_list_response.rb +9 -1
- data/lib/whop_sdk/models/company_update_params.rb +96 -0
- data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +11 -1
- data/lib/whop_sdk/models/withdrawal_list_response.rb +11 -1
- data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +11 -1
- data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +11 -1
- data/lib/whop_sdk/models.rb +2 -0
- data/lib/whop_sdk/resources/companies.rb +45 -3
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +1 -0
- data/rbi/whop_sdk/models/company.rbi +8 -0
- data/rbi/whop_sdk/models/company_create_params.rbi +14 -0
- data/rbi/whop_sdk/models/company_list_params.rbi +2 -2
- data/rbi/whop_sdk/models/company_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/company_update_params.rbi +167 -0
- data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +12 -0
- data/rbi/whop_sdk/models/withdrawal_list_response.rbi +12 -0
- data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +12 -0
- data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +12 -0
- data/rbi/whop_sdk/models.rbi +2 -0
- data/rbi/whop_sdk/resources/companies.rbi +46 -2
- data/sig/whop_sdk/models/company.rbs +5 -0
- data/sig/whop_sdk/models/company_create_params.rbs +6 -1
- data/sig/whop_sdk/models/company_list_response.rbs +5 -0
- data/sig/whop_sdk/models/company_update_params.rbs +67 -0
- data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +5 -0
- data/sig/whop_sdk/models/withdrawal_list_response.rbs +5 -0
- data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +5 -0
- data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +5 -0
- data/sig/whop_sdk/models.rbs +2 -0
- data/sig/whop_sdk/resources/companies.rbs +9 -0
- metadata +5 -2
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class CompanyUpdateParams < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
7
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
8
|
+
|
|
9
|
+
OrHash =
|
|
10
|
+
T.type_alias do
|
|
11
|
+
T.any(WhopSDK::CompanyUpdateParams, WhopSDK::Internal::AnyHash)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
# The logo for the company in png, jpeg, or gif format
|
|
15
|
+
sig do
|
|
16
|
+
returns(
|
|
17
|
+
T.nilable(
|
|
18
|
+
T.any(
|
|
19
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID,
|
|
20
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID
|
|
21
|
+
)
|
|
22
|
+
)
|
|
23
|
+
)
|
|
24
|
+
end
|
|
25
|
+
attr_accessor :logo
|
|
26
|
+
|
|
27
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
28
|
+
# Includes: order confirmations, payment failures, refund notifications, upcoming
|
|
29
|
+
# renewals, and membership cancelations/expirations. When disabled, the platform
|
|
30
|
+
# is responsible for handling these communications.
|
|
31
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
32
|
+
attr_accessor :send_customer_emails
|
|
33
|
+
|
|
34
|
+
# The title of the company
|
|
35
|
+
sig { returns(T.nilable(String)) }
|
|
36
|
+
attr_accessor :title
|
|
37
|
+
|
|
38
|
+
sig do
|
|
39
|
+
params(
|
|
40
|
+
logo:
|
|
41
|
+
T.nilable(
|
|
42
|
+
T.any(
|
|
43
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID::OrHash,
|
|
44
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID::OrHash
|
|
45
|
+
)
|
|
46
|
+
),
|
|
47
|
+
send_customer_emails: T.nilable(T::Boolean),
|
|
48
|
+
title: T.nilable(String),
|
|
49
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
50
|
+
).returns(T.attached_class)
|
|
51
|
+
end
|
|
52
|
+
def self.new(
|
|
53
|
+
# The logo for the company in png, jpeg, or gif format
|
|
54
|
+
logo: nil,
|
|
55
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
56
|
+
# Includes: order confirmations, payment failures, refund notifications, upcoming
|
|
57
|
+
# renewals, and membership cancelations/expirations. When disabled, the platform
|
|
58
|
+
# is responsible for handling these communications.
|
|
59
|
+
send_customer_emails: nil,
|
|
60
|
+
# The title of the company
|
|
61
|
+
title: nil,
|
|
62
|
+
request_options: {}
|
|
63
|
+
)
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
sig do
|
|
67
|
+
override.returns(
|
|
68
|
+
{
|
|
69
|
+
logo:
|
|
70
|
+
T.nilable(
|
|
71
|
+
T.any(
|
|
72
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID,
|
|
73
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID
|
|
74
|
+
)
|
|
75
|
+
),
|
|
76
|
+
send_customer_emails: T.nilable(T::Boolean),
|
|
77
|
+
title: T.nilable(String),
|
|
78
|
+
request_options: WhopSDK::RequestOptions
|
|
79
|
+
}
|
|
80
|
+
)
|
|
81
|
+
end
|
|
82
|
+
def to_hash
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# The logo for the company in png, jpeg, or gif format
|
|
86
|
+
module Logo
|
|
87
|
+
extend WhopSDK::Internal::Type::Union
|
|
88
|
+
|
|
89
|
+
Variants =
|
|
90
|
+
T.type_alias do
|
|
91
|
+
T.any(
|
|
92
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID,
|
|
93
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID
|
|
94
|
+
)
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
98
|
+
OrHash =
|
|
99
|
+
T.type_alias do
|
|
100
|
+
T.any(
|
|
101
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID,
|
|
102
|
+
WhopSDK::Internal::AnyHash
|
|
103
|
+
)
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
107
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
108
|
+
# mediaDirectUpload mutation.
|
|
109
|
+
sig { returns(String) }
|
|
110
|
+
attr_accessor :direct_upload_id
|
|
111
|
+
|
|
112
|
+
# Input for an attachment
|
|
113
|
+
sig { params(direct_upload_id: String).returns(T.attached_class) }
|
|
114
|
+
def self.new(
|
|
115
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
116
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
117
|
+
# mediaDirectUpload mutation.
|
|
118
|
+
direct_upload_id:
|
|
119
|
+
)
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
sig { override.returns({ direct_upload_id: String }) }
|
|
123
|
+
def to_hash
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
128
|
+
OrHash =
|
|
129
|
+
T.type_alias do
|
|
130
|
+
T.any(
|
|
131
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID,
|
|
132
|
+
WhopSDK::Internal::AnyHash
|
|
133
|
+
)
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
137
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
138
|
+
# doing.
|
|
139
|
+
sig { returns(String) }
|
|
140
|
+
attr_accessor :id
|
|
141
|
+
|
|
142
|
+
# Input for an attachment
|
|
143
|
+
sig { params(id: String).returns(T.attached_class) }
|
|
144
|
+
def self.new(
|
|
145
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
146
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
147
|
+
# doing.
|
|
148
|
+
id:
|
|
149
|
+
)
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
sig { override.returns({ id: String }) }
|
|
153
|
+
def to_hash
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
sig do
|
|
158
|
+
override.returns(
|
|
159
|
+
T::Array[WhopSDK::CompanyUpdateParams::Logo::Variants]
|
|
160
|
+
)
|
|
161
|
+
end
|
|
162
|
+
def self.variants
|
|
163
|
+
end
|
|
164
|
+
end
|
|
165
|
+
end
|
|
166
|
+
end
|
|
167
|
+
end
|
|
@@ -139,6 +139,12 @@ module WhopSDK
|
|
|
139
139
|
end
|
|
140
140
|
attr_writer :ledger_account
|
|
141
141
|
|
|
142
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
143
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
144
|
+
# Rails.
|
|
145
|
+
sig { returns(Float) }
|
|
146
|
+
attr_accessor :markup_fee
|
|
147
|
+
|
|
142
148
|
# The payout token used for the withdrawal, if applicable.
|
|
143
149
|
sig do
|
|
144
150
|
returns(
|
|
@@ -191,6 +197,7 @@ module WhopSDK
|
|
|
191
197
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
|
|
192
198
|
ledger_account:
|
|
193
199
|
WhopSDK::WithdrawalCreatedWebhookEvent::Data::LedgerAccount::OrHash,
|
|
200
|
+
markup_fee: Float,
|
|
194
201
|
payout_token:
|
|
195
202
|
T.nilable(
|
|
196
203
|
WhopSDK::WithdrawalCreatedWebhookEvent::Data::PayoutToken::OrHash
|
|
@@ -223,6 +230,10 @@ module WhopSDK
|
|
|
223
230
|
fee_type:,
|
|
224
231
|
# The ledger account associated with the withdrawal.
|
|
225
232
|
ledger_account:,
|
|
233
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
234
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
235
|
+
# Rails.
|
|
236
|
+
markup_fee:,
|
|
226
237
|
# The payout token used for the withdrawal, if applicable.
|
|
227
238
|
payout_token:,
|
|
228
239
|
# The speed of the withdrawal.
|
|
@@ -254,6 +265,7 @@ module WhopSDK
|
|
|
254
265
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
|
|
255
266
|
ledger_account:
|
|
256
267
|
WhopSDK::WithdrawalCreatedWebhookEvent::Data::LedgerAccount,
|
|
268
|
+
markup_fee: Float,
|
|
257
269
|
payout_token:
|
|
258
270
|
T.nilable(
|
|
259
271
|
WhopSDK::WithdrawalCreatedWebhookEvent::Data::PayoutToken
|
|
@@ -36,6 +36,12 @@ module WhopSDK
|
|
|
36
36
|
sig { returns(T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol)) }
|
|
37
37
|
attr_accessor :fee_type
|
|
38
38
|
|
|
39
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
40
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
41
|
+
# Rails.
|
|
42
|
+
sig { returns(Float) }
|
|
43
|
+
attr_accessor :markup_fee
|
|
44
|
+
|
|
39
45
|
# The speed of the withdrawal.
|
|
40
46
|
sig { returns(WhopSDK::WithdrawalSpeeds::TaggedSymbol) }
|
|
41
47
|
attr_accessor :speed
|
|
@@ -57,6 +63,7 @@ module WhopSDK
|
|
|
57
63
|
currency: WhopSDK::Currency::OrSymbol,
|
|
58
64
|
fee_amount: Float,
|
|
59
65
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
|
|
66
|
+
markup_fee: Float,
|
|
60
67
|
speed: WhopSDK::WithdrawalSpeeds::OrSymbol,
|
|
61
68
|
status: WhopSDK::WithdrawalStatus::OrSymbol,
|
|
62
69
|
withdrawal_type: WhopSDK::WithdrawalTypes::OrSymbol
|
|
@@ -76,6 +83,10 @@ module WhopSDK
|
|
|
76
83
|
fee_amount:,
|
|
77
84
|
# The different fee types for a withdrawal.
|
|
78
85
|
fee_type:,
|
|
86
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
87
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
88
|
+
# Rails.
|
|
89
|
+
markup_fee:,
|
|
79
90
|
# The speed of the withdrawal.
|
|
80
91
|
speed:,
|
|
81
92
|
# Status of the withdrawal.
|
|
@@ -94,6 +105,7 @@ module WhopSDK
|
|
|
94
105
|
currency: WhopSDK::Currency::TaggedSymbol,
|
|
95
106
|
fee_amount: Float,
|
|
96
107
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
|
|
108
|
+
markup_fee: Float,
|
|
97
109
|
speed: WhopSDK::WithdrawalSpeeds::TaggedSymbol,
|
|
98
110
|
status: WhopSDK::WithdrawalStatus::TaggedSymbol,
|
|
99
111
|
withdrawal_type: WhopSDK::WithdrawalTypes::TaggedSymbol
|
|
@@ -68,6 +68,12 @@ module WhopSDK
|
|
|
68
68
|
end
|
|
69
69
|
attr_writer :ledger_account
|
|
70
70
|
|
|
71
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
72
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
73
|
+
# Rails.
|
|
74
|
+
sig { returns(Float) }
|
|
75
|
+
attr_accessor :markup_fee
|
|
76
|
+
|
|
71
77
|
# The payout token used for the withdrawal, if applicable.
|
|
72
78
|
sig do
|
|
73
79
|
returns(
|
|
@@ -120,6 +126,7 @@ module WhopSDK
|
|
|
120
126
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
|
|
121
127
|
ledger_account:
|
|
122
128
|
WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount::OrHash,
|
|
129
|
+
markup_fee: Float,
|
|
123
130
|
payout_token:
|
|
124
131
|
T.nilable(
|
|
125
132
|
WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::OrHash
|
|
@@ -152,6 +159,10 @@ module WhopSDK
|
|
|
152
159
|
fee_type:,
|
|
153
160
|
# The ledger account associated with the withdrawal.
|
|
154
161
|
ledger_account:,
|
|
162
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
163
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
164
|
+
# Rails.
|
|
165
|
+
markup_fee:,
|
|
155
166
|
# The payout token used for the withdrawal, if applicable.
|
|
156
167
|
payout_token:,
|
|
157
168
|
# The speed of the withdrawal.
|
|
@@ -183,6 +194,7 @@ module WhopSDK
|
|
|
183
194
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
|
|
184
195
|
ledger_account:
|
|
185
196
|
WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount,
|
|
197
|
+
markup_fee: Float,
|
|
186
198
|
payout_token:
|
|
187
199
|
T.nilable(
|
|
188
200
|
WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken
|
|
@@ -139,6 +139,12 @@ module WhopSDK
|
|
|
139
139
|
end
|
|
140
140
|
attr_writer :ledger_account
|
|
141
141
|
|
|
142
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
143
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
144
|
+
# Rails.
|
|
145
|
+
sig { returns(Float) }
|
|
146
|
+
attr_accessor :markup_fee
|
|
147
|
+
|
|
142
148
|
# The payout token used for the withdrawal, if applicable.
|
|
143
149
|
sig do
|
|
144
150
|
returns(
|
|
@@ -191,6 +197,7 @@ module WhopSDK
|
|
|
191
197
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
|
|
192
198
|
ledger_account:
|
|
193
199
|
WhopSDK::WithdrawalUpdatedWebhookEvent::Data::LedgerAccount::OrHash,
|
|
200
|
+
markup_fee: Float,
|
|
194
201
|
payout_token:
|
|
195
202
|
T.nilable(
|
|
196
203
|
WhopSDK::WithdrawalUpdatedWebhookEvent::Data::PayoutToken::OrHash
|
|
@@ -223,6 +230,10 @@ module WhopSDK
|
|
|
223
230
|
fee_type:,
|
|
224
231
|
# The ledger account associated with the withdrawal.
|
|
225
232
|
ledger_account:,
|
|
233
|
+
# The markup fee that was charged for the withdrawal. This is in the same currency
|
|
234
|
+
# as the withdrawal amount. This only applies to platform accounts using Whop
|
|
235
|
+
# Rails.
|
|
236
|
+
markup_fee:,
|
|
226
237
|
# The payout token used for the withdrawal, if applicable.
|
|
227
238
|
payout_token:,
|
|
228
239
|
# The speed of the withdrawal.
|
|
@@ -254,6 +265,7 @@ module WhopSDK
|
|
|
254
265
|
fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
|
|
255
266
|
ledger_account:
|
|
256
267
|
WhopSDK::WithdrawalUpdatedWebhookEvent::Data::LedgerAccount,
|
|
268
|
+
markup_fee: Float,
|
|
257
269
|
payout_token:
|
|
258
270
|
T.nilable(
|
|
259
271
|
WhopSDK::WithdrawalUpdatedWebhookEvent::Data::PayoutToken
|
data/rbi/whop_sdk/models.rbi
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
module WhopSDK
|
|
4
4
|
module Resources
|
|
5
5
|
class Companies
|
|
6
|
-
# Create a new
|
|
6
|
+
# Create a new connected account for your platform
|
|
7
7
|
#
|
|
8
8
|
# Required permissions:
|
|
9
9
|
#
|
|
@@ -15,6 +15,7 @@ module WhopSDK
|
|
|
15
15
|
parent_company_id: String,
|
|
16
16
|
title: String,
|
|
17
17
|
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
18
|
+
send_customer_emails: T.nilable(T::Boolean),
|
|
18
19
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
19
20
|
).returns(WhopSDK::Company)
|
|
20
21
|
end
|
|
@@ -27,6 +28,11 @@ module WhopSDK
|
|
|
27
28
|
title:,
|
|
28
29
|
# Additional metadata for the account
|
|
29
30
|
metadata: nil,
|
|
31
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
32
|
+
# Includes: order confirmations, payment failures, refund notifications, upcoming
|
|
33
|
+
# renewals, and membership cancelations/expirations. When disabled, the platform
|
|
34
|
+
# is responsible for handling these communications. This is defaulted to true.
|
|
35
|
+
send_customer_emails: nil,
|
|
30
36
|
request_options: {}
|
|
31
37
|
)
|
|
32
38
|
end
|
|
@@ -49,6 +55,44 @@ module WhopSDK
|
|
|
49
55
|
)
|
|
50
56
|
end
|
|
51
57
|
|
|
58
|
+
# Update an existing company. Either a regular company, platform company, or one
|
|
59
|
+
# of a platform's connected accounts
|
|
60
|
+
#
|
|
61
|
+
# Required permissions:
|
|
62
|
+
#
|
|
63
|
+
# - `company:update`
|
|
64
|
+
# - `company:basic:read`
|
|
65
|
+
sig do
|
|
66
|
+
params(
|
|
67
|
+
id: String,
|
|
68
|
+
logo:
|
|
69
|
+
T.nilable(
|
|
70
|
+
T.any(
|
|
71
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID::OrHash,
|
|
72
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID::OrHash
|
|
73
|
+
)
|
|
74
|
+
),
|
|
75
|
+
send_customer_emails: T.nilable(T::Boolean),
|
|
76
|
+
title: T.nilable(String),
|
|
77
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
78
|
+
).returns(WhopSDK::Company)
|
|
79
|
+
end
|
|
80
|
+
def update(
|
|
81
|
+
# The ID of the company to update
|
|
82
|
+
id,
|
|
83
|
+
# The logo for the company in png, jpeg, or gif format
|
|
84
|
+
logo: nil,
|
|
85
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
86
|
+
# Includes: order confirmations, payment failures, refund notifications, upcoming
|
|
87
|
+
# renewals, and membership cancelations/expirations. When disabled, the platform
|
|
88
|
+
# is responsible for handling these communications.
|
|
89
|
+
send_customer_emails: nil,
|
|
90
|
+
# The title of the company
|
|
91
|
+
title: nil,
|
|
92
|
+
request_options: {}
|
|
93
|
+
)
|
|
94
|
+
end
|
|
95
|
+
|
|
52
96
|
# Lists companies the current user has access to
|
|
53
97
|
#
|
|
54
98
|
# Required permissions:
|
|
@@ -70,7 +114,7 @@ module WhopSDK
|
|
|
70
114
|
)
|
|
71
115
|
end
|
|
72
116
|
def list(
|
|
73
|
-
# The ID of the parent company to list
|
|
117
|
+
# The ID of the parent company to list connected accounts for
|
|
74
118
|
parent_company_id:,
|
|
75
119
|
# Returns the elements in the list that come after the specified cursor.
|
|
76
120
|
after: nil,
|
|
@@ -13,6 +13,7 @@ module WhopSDK
|
|
|
13
13
|
owner_user: WhopSDK::Company::OwnerUser,
|
|
14
14
|
published_reviews_count: Integer,
|
|
15
15
|
route: String,
|
|
16
|
+
send_customer_emails: bool,
|
|
16
17
|
social_links: ::Array[WhopSDK::Company::SocialLink],
|
|
17
18
|
title: String,
|
|
18
19
|
updated_at: Time,
|
|
@@ -42,6 +43,8 @@ module WhopSDK
|
|
|
42
43
|
|
|
43
44
|
attr_accessor route: String
|
|
44
45
|
|
|
46
|
+
attr_accessor send_customer_emails: bool
|
|
47
|
+
|
|
45
48
|
attr_accessor social_links: ::Array[WhopSDK::Company::SocialLink]
|
|
46
49
|
|
|
47
50
|
attr_accessor title: String
|
|
@@ -62,6 +65,7 @@ module WhopSDK
|
|
|
62
65
|
owner_user: WhopSDK::Company::OwnerUser,
|
|
63
66
|
published_reviews_count: Integer,
|
|
64
67
|
route: String,
|
|
68
|
+
send_customer_emails: bool,
|
|
65
69
|
social_links: ::Array[WhopSDK::Company::SocialLink],
|
|
66
70
|
title: String,
|
|
67
71
|
updated_at: Time,
|
|
@@ -80,6 +84,7 @@ module WhopSDK
|
|
|
80
84
|
owner_user: WhopSDK::Company::OwnerUser,
|
|
81
85
|
published_reviews_count: Integer,
|
|
82
86
|
route: String,
|
|
87
|
+
send_customer_emails: bool,
|
|
83
88
|
social_links: ::Array[WhopSDK::Company::SocialLink],
|
|
84
89
|
title: String,
|
|
85
90
|
updated_at: Time,
|
|
@@ -5,7 +5,8 @@ module WhopSDK
|
|
|
5
5
|
email: String,
|
|
6
6
|
parent_company_id: String,
|
|
7
7
|
title: String,
|
|
8
|
-
metadata: ::Hash[Symbol, top]
|
|
8
|
+
metadata: ::Hash[Symbol, top]?,
|
|
9
|
+
send_customer_emails: bool?
|
|
9
10
|
}
|
|
10
11
|
& WhopSDK::Internal::Type::request_parameters
|
|
11
12
|
|
|
@@ -21,11 +22,14 @@ module WhopSDK
|
|
|
21
22
|
|
|
22
23
|
attr_accessor metadata: ::Hash[Symbol, top]?
|
|
23
24
|
|
|
25
|
+
attr_accessor send_customer_emails: bool?
|
|
26
|
+
|
|
24
27
|
def initialize: (
|
|
25
28
|
email: String,
|
|
26
29
|
parent_company_id: String,
|
|
27
30
|
title: String,
|
|
28
31
|
?metadata: ::Hash[Symbol, top]?,
|
|
32
|
+
?send_customer_emails: bool?,
|
|
29
33
|
?request_options: WhopSDK::request_opts
|
|
30
34
|
) -> void
|
|
31
35
|
|
|
@@ -34,6 +38,7 @@ module WhopSDK
|
|
|
34
38
|
parent_company_id: String,
|
|
35
39
|
title: String,
|
|
36
40
|
metadata: ::Hash[Symbol, top]?,
|
|
41
|
+
send_customer_emails: bool?,
|
|
37
42
|
request_options: WhopSDK::RequestOptions
|
|
38
43
|
}
|
|
39
44
|
end
|
|
@@ -13,6 +13,7 @@ module WhopSDK
|
|
|
13
13
|
owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser,
|
|
14
14
|
published_reviews_count: Integer,
|
|
15
15
|
route: String,
|
|
16
|
+
send_customer_emails: bool,
|
|
16
17
|
title: String,
|
|
17
18
|
updated_at: Time,
|
|
18
19
|
verified: bool
|
|
@@ -41,6 +42,8 @@ module WhopSDK
|
|
|
41
42
|
|
|
42
43
|
attr_accessor route: String
|
|
43
44
|
|
|
45
|
+
attr_accessor send_customer_emails: bool
|
|
46
|
+
|
|
44
47
|
attr_accessor title: String
|
|
45
48
|
|
|
46
49
|
attr_accessor updated_at: Time
|
|
@@ -59,6 +62,7 @@ module WhopSDK
|
|
|
59
62
|
owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser,
|
|
60
63
|
published_reviews_count: Integer,
|
|
61
64
|
route: String,
|
|
65
|
+
send_customer_emails: bool,
|
|
62
66
|
title: String,
|
|
63
67
|
updated_at: Time,
|
|
64
68
|
verified: bool
|
|
@@ -76,6 +80,7 @@ module WhopSDK
|
|
|
76
80
|
owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser,
|
|
77
81
|
published_reviews_count: Integer,
|
|
78
82
|
route: String,
|
|
83
|
+
send_customer_emails: bool,
|
|
79
84
|
title: String,
|
|
80
85
|
updated_at: Time,
|
|
81
86
|
verified: bool
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
module WhopSDK
|
|
2
|
+
module Models
|
|
3
|
+
type company_update_params =
|
|
4
|
+
{
|
|
5
|
+
logo: WhopSDK::Models::CompanyUpdateParams::logo?,
|
|
6
|
+
send_customer_emails: bool?,
|
|
7
|
+
title: String?
|
|
8
|
+
}
|
|
9
|
+
& WhopSDK::Internal::Type::request_parameters
|
|
10
|
+
|
|
11
|
+
class CompanyUpdateParams < WhopSDK::Internal::Type::BaseModel
|
|
12
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
13
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
14
|
+
|
|
15
|
+
attr_accessor logo: WhopSDK::Models::CompanyUpdateParams::logo?
|
|
16
|
+
|
|
17
|
+
attr_accessor send_customer_emails: bool?
|
|
18
|
+
|
|
19
|
+
attr_accessor title: String?
|
|
20
|
+
|
|
21
|
+
def initialize: (
|
|
22
|
+
?logo: WhopSDK::Models::CompanyUpdateParams::logo?,
|
|
23
|
+
?send_customer_emails: bool?,
|
|
24
|
+
?title: String?,
|
|
25
|
+
?request_options: WhopSDK::request_opts
|
|
26
|
+
) -> void
|
|
27
|
+
|
|
28
|
+
def to_hash: -> {
|
|
29
|
+
logo: WhopSDK::Models::CompanyUpdateParams::logo?,
|
|
30
|
+
send_customer_emails: bool?,
|
|
31
|
+
title: String?,
|
|
32
|
+
request_options: WhopSDK::RequestOptions
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
type logo =
|
|
36
|
+
WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID
|
|
37
|
+
| WhopSDK::CompanyUpdateParams::Logo::AttachmentInputWithID
|
|
38
|
+
|
|
39
|
+
module Logo
|
|
40
|
+
extend WhopSDK::Internal::Type::Union
|
|
41
|
+
|
|
42
|
+
type attachment_input_with_direct_upload_id =
|
|
43
|
+
{ direct_upload_id: String }
|
|
44
|
+
|
|
45
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
46
|
+
attr_accessor direct_upload_id: String
|
|
47
|
+
|
|
48
|
+
def initialize: (direct_upload_id: String) -> void
|
|
49
|
+
|
|
50
|
+
def to_hash: -> { direct_upload_id: String }
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
type attachment_input_with_id = { id: String }
|
|
54
|
+
|
|
55
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
56
|
+
attr_accessor id: String
|
|
57
|
+
|
|
58
|
+
def initialize: (id: String) -> void
|
|
59
|
+
|
|
60
|
+
def to_hash: -> { id: String }
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
def self?.variants: -> ::Array[WhopSDK::Models::CompanyUpdateParams::logo]
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
@@ -48,6 +48,7 @@ module WhopSDK
|
|
|
48
48
|
fee_amount: Float,
|
|
49
49
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
50
50
|
ledger_account: WhopSDK::WithdrawalCreatedWebhookEvent::Data::LedgerAccount,
|
|
51
|
+
markup_fee: Float,
|
|
51
52
|
payout_token: WhopSDK::WithdrawalCreatedWebhookEvent::Data::PayoutToken?,
|
|
52
53
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
53
54
|
status: WhopSDK::Models::withdrawal_status,
|
|
@@ -76,6 +77,8 @@ module WhopSDK
|
|
|
76
77
|
|
|
77
78
|
attr_accessor ledger_account: WhopSDK::WithdrawalCreatedWebhookEvent::Data::LedgerAccount
|
|
78
79
|
|
|
80
|
+
attr_accessor markup_fee: Float
|
|
81
|
+
|
|
79
82
|
attr_accessor payout_token: WhopSDK::WithdrawalCreatedWebhookEvent::Data::PayoutToken?
|
|
80
83
|
|
|
81
84
|
attr_accessor speed: WhopSDK::Models::withdrawal_speeds
|
|
@@ -97,6 +100,7 @@ module WhopSDK
|
|
|
97
100
|
fee_amount: Float,
|
|
98
101
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
99
102
|
ledger_account: WhopSDK::WithdrawalCreatedWebhookEvent::Data::LedgerAccount,
|
|
103
|
+
markup_fee: Float,
|
|
100
104
|
payout_token: WhopSDK::WithdrawalCreatedWebhookEvent::Data::PayoutToken?,
|
|
101
105
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
102
106
|
status: WhopSDK::Models::withdrawal_status,
|
|
@@ -115,6 +119,7 @@ module WhopSDK
|
|
|
115
119
|
fee_amount: Float,
|
|
116
120
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
117
121
|
ledger_account: WhopSDK::WithdrawalCreatedWebhookEvent::Data::LedgerAccount,
|
|
122
|
+
markup_fee: Float,
|
|
118
123
|
payout_token: WhopSDK::WithdrawalCreatedWebhookEvent::Data::PayoutToken?,
|
|
119
124
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
120
125
|
status: WhopSDK::Models::withdrawal_status,
|
|
@@ -8,6 +8,7 @@ module WhopSDK
|
|
|
8
8
|
currency: WhopSDK::Models::currency,
|
|
9
9
|
fee_amount: Float,
|
|
10
10
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
11
|
+
markup_fee: Float,
|
|
11
12
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
12
13
|
status: WhopSDK::Models::withdrawal_status,
|
|
13
14
|
withdrawal_type: WhopSDK::Models::withdrawal_types
|
|
@@ -26,6 +27,8 @@ module WhopSDK
|
|
|
26
27
|
|
|
27
28
|
attr_accessor fee_type: WhopSDK::Models::withdrawal_fee_types?
|
|
28
29
|
|
|
30
|
+
attr_accessor markup_fee: Float
|
|
31
|
+
|
|
29
32
|
attr_accessor speed: WhopSDK::Models::withdrawal_speeds
|
|
30
33
|
|
|
31
34
|
attr_accessor status: WhopSDK::Models::withdrawal_status
|
|
@@ -39,6 +42,7 @@ module WhopSDK
|
|
|
39
42
|
currency: WhopSDK::Models::currency,
|
|
40
43
|
fee_amount: Float,
|
|
41
44
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
45
|
+
markup_fee: Float,
|
|
42
46
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
43
47
|
status: WhopSDK::Models::withdrawal_status,
|
|
44
48
|
withdrawal_type: WhopSDK::Models::withdrawal_types
|
|
@@ -51,6 +55,7 @@ module WhopSDK
|
|
|
51
55
|
currency: WhopSDK::Models::currency,
|
|
52
56
|
fee_amount: Float,
|
|
53
57
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
58
|
+
markup_fee: Float,
|
|
54
59
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
55
60
|
status: WhopSDK::Models::withdrawal_status,
|
|
56
61
|
withdrawal_type: WhopSDK::Models::withdrawal_types
|
|
@@ -12,6 +12,7 @@ module WhopSDK
|
|
|
12
12
|
fee_amount: Float,
|
|
13
13
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
14
14
|
ledger_account: WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount,
|
|
15
|
+
markup_fee: Float,
|
|
15
16
|
payout_token: WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken?,
|
|
16
17
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
17
18
|
status: WhopSDK::Models::withdrawal_status,
|
|
@@ -40,6 +41,8 @@ module WhopSDK
|
|
|
40
41
|
|
|
41
42
|
attr_accessor ledger_account: WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount
|
|
42
43
|
|
|
44
|
+
attr_accessor markup_fee: Float
|
|
45
|
+
|
|
43
46
|
attr_accessor payout_token: WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken?
|
|
44
47
|
|
|
45
48
|
attr_accessor speed: WhopSDK::Models::withdrawal_speeds
|
|
@@ -61,6 +64,7 @@ module WhopSDK
|
|
|
61
64
|
fee_amount: Float,
|
|
62
65
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
63
66
|
ledger_account: WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount,
|
|
67
|
+
markup_fee: Float,
|
|
64
68
|
payout_token: WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken?,
|
|
65
69
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
66
70
|
status: WhopSDK::Models::withdrawal_status,
|
|
@@ -79,6 +83,7 @@ module WhopSDK
|
|
|
79
83
|
fee_amount: Float,
|
|
80
84
|
fee_type: WhopSDK::Models::withdrawal_fee_types?,
|
|
81
85
|
ledger_account: WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount,
|
|
86
|
+
markup_fee: Float,
|
|
82
87
|
payout_token: WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken?,
|
|
83
88
|
speed: WhopSDK::Models::withdrawal_speeds,
|
|
84
89
|
status: WhopSDK::Models::withdrawal_status,
|