whop_sdk 0.0.13 → 0.0.15
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 +20 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +4 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +9 -1
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +9 -1
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +9 -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_response.rb +9 -1
- data/lib/whop_sdk/models/company_update_params.rb +15 -1
- data/lib/whop_sdk/models/experience.rb +9 -1
- data/lib/whop_sdk/models/experience_create_params.rb +9 -1
- data/lib/whop_sdk/models/experience_list_response.rb +9 -1
- data/lib/whop_sdk/models/experience_update_params.rb +9 -1
- data/lib/whop_sdk/models/fee_markup_create_params.rb +62 -0
- data/lib/whop_sdk/models/fee_markup_create_response.rb +67 -0
- data/lib/whop_sdk/models/fee_markup_delete_params.rb +14 -0
- data/lib/whop_sdk/models/fee_markup_delete_response.rb +8 -0
- data/lib/whop_sdk/models/fee_markup_list_params.rb +58 -0
- data/lib/whop_sdk/models/fee_markup_list_response.rb +67 -0
- data/lib/whop_sdk/models/fee_markup_type.rb +19 -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 +8 -0
- data/lib/whop_sdk/resources/checkout_configurations.rb +3 -1
- data/lib/whop_sdk/resources/companies.rb +12 -2
- data/lib/whop_sdk/resources/experiences.rb +6 -2
- data/lib/whop_sdk/resources/fee_markups.rb +112 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +8 -0
- data/rbi/whop_sdk/client.rbi +3 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +8 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +8 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +8 -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_response.rbi +8 -0
- data/rbi/whop_sdk/models/company_update_params.rbi +14 -0
- data/rbi/whop_sdk/models/experience.rbi +8 -0
- data/rbi/whop_sdk/models/experience_create_params.rbi +8 -0
- data/rbi/whop_sdk/models/experience_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/experience_update_params.rbi +8 -0
- data/rbi/whop_sdk/models/fee_markup_create_params.rbi +83 -0
- data/rbi/whop_sdk/models/fee_markup_create_response.rbi +89 -0
- data/rbi/whop_sdk/models/fee_markup_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/fee_markup_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/fee_markup_list_params.rbi +77 -0
- data/rbi/whop_sdk/models/fee_markup_list_response.rbi +89 -0
- data/rbi/whop_sdk/models/fee_markup_type.rbi +37 -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 +8 -0
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +3 -0
- data/rbi/whop_sdk/resources/companies.rbi +12 -0
- data/rbi/whop_sdk/resources/experiences.rbi +6 -0
- data/rbi/whop_sdk/resources/fee_markups.rbi +96 -0
- data/sig/whop_sdk/client.rbs +2 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +5 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +5 -0
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +5 -0
- 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 +9 -1
- data/sig/whop_sdk/models/experience.rbs +5 -0
- data/sig/whop_sdk/models/experience_create_params.rbs +11 -1
- data/sig/whop_sdk/models/experience_list_response.rbs +5 -0
- data/sig/whop_sdk/models/experience_update_params.rbs +5 -0
- data/sig/whop_sdk/models/fee_markup_create_params.rbs +51 -0
- data/sig/whop_sdk/models/fee_markup_create_response.rbs +50 -0
- data/sig/whop_sdk/models/fee_markup_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/fee_markup_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/fee_markup_list_params.rbs +46 -0
- data/sig/whop_sdk/models/fee_markup_list_response.rbs +50 -0
- data/sig/whop_sdk/models/fee_markup_type.rbs +22 -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 +8 -0
- data/sig/whop_sdk/resources/checkout_configurations.rbs +1 -0
- data/sig/whop_sdk/resources/companies.rbs +2 -0
- data/sig/whop_sdk/resources/experiences.rbs +2 -0
- data/sig/whop_sdk/resources/fee_markups.rbs +28 -0
- metadata +26 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4344ab01b285213d6082d33945609e80cae719fb8ab415e3bccc296e1ff29484
|
|
4
|
+
data.tar.gz: d96cc8ec1739472bf325cc8f08328b2dfa77cf960ee186e215b7bce38c51e03d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9cbdc98042ba62ff6ee24e23e5692c854437b1aa43c611ddea3748afb3faeeb4d99d276a1e1557c6af33892342d883a7c0a5711990539ea5c710a1a2b13ad83e
|
|
7
|
+
data.tar.gz: b450bb246eaef4ad7b7960075fa0e65b9a30fa9894c008ed5bdf7b7289aed7708c93253e4119204d7be2b05fdbd1299bef6904ec5cbfe99a579644e6b190f517
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.0.15 (2025-12-09)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.0.14...v0.0.15](https://github.com/whopio/whopsdk-ruby/compare/v0.0.14...v0.0.15)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([d40fe0c](https://github.com/whopio/whopsdk-ruby/commit/d40fe0ceff3705451dea07c84c48c0dc8cfe054c))
|
|
10
|
+
* **api:** api update ([c6f7d11](https://github.com/whopio/whopsdk-ruby/commit/c6f7d1190420adaf72b689d7823b3752d4bc0bf4))
|
|
11
|
+
* **api:** manual updates ([7b169f8](https://github.com/whopio/whopsdk-ruby/commit/7b169f8eefec6325e111b9841a212fa0f081b3ba))
|
|
12
|
+
|
|
13
|
+
## 0.0.14 (2025-12-07)
|
|
14
|
+
|
|
15
|
+
Full Changelog: [v0.0.13...v0.0.14](https://github.com/whopio/whopsdk-ruby/compare/v0.0.13...v0.0.14)
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **api:** api update ([8515327](https://github.com/whopio/whopsdk-ruby/commit/8515327ce19264fd2b3d0774ef501941c29e8673))
|
|
20
|
+
* **api:** api update ([1dae032](https://github.com/whopio/whopsdk-ruby/commit/1dae03238e8624959bffcd188140d2976601809d))
|
|
21
|
+
* **api:** api update ([925f7eb](https://github.com/whopio/whopsdk-ruby/commit/925f7eb7a9c2f9eb5103ccd84274de6f636ea427))
|
|
22
|
+
|
|
3
23
|
## 0.0.13 (2025-12-05)
|
|
4
24
|
|
|
5
25
|
Full Changelog: [v0.0.12...v0.0.13](https://github.com/whopio/whopsdk-ruby/compare/v0.0.12...v0.0.13)
|
data/README.md
CHANGED
data/lib/whop_sdk/client.rb
CHANGED
|
@@ -141,6 +141,9 @@ module WhopSDK
|
|
|
141
141
|
# @return [WhopSDK::Resources::PaymentMethods]
|
|
142
142
|
attr_reader :payment_methods
|
|
143
143
|
|
|
144
|
+
# @return [WhopSDK::Resources::FeeMarkups]
|
|
145
|
+
attr_reader :fee_markups
|
|
146
|
+
|
|
144
147
|
# @api private
|
|
145
148
|
#
|
|
146
149
|
# @return [Hash{String=>String}]
|
|
@@ -237,6 +240,7 @@ module WhopSDK
|
|
|
237
240
|
@account_links = WhopSDK::Resources::AccountLinks.new(client: self)
|
|
238
241
|
@setup_intents = WhopSDK::Resources::SetupIntents.new(client: self)
|
|
239
242
|
@payment_methods = WhopSDK::Resources::PaymentMethods.new(client: self)
|
|
243
|
+
@fee_markups = WhopSDK::Resources::FeeMarkups.new(client: self)
|
|
240
244
|
end
|
|
241
245
|
|
|
242
246
|
# Verifies a Whop user token
|
|
@@ -21,6 +21,12 @@ module WhopSDK
|
|
|
21
21
|
# @return [String]
|
|
22
22
|
required :company_id, String
|
|
23
23
|
|
|
24
|
+
# @!attribute currency
|
|
25
|
+
# The available currencies on the platform
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, WhopSDK::Models::Currency, nil]
|
|
28
|
+
required :currency, enum: -> { WhopSDK::Currency }, nil?: true
|
|
29
|
+
|
|
24
30
|
# @!attribute metadata
|
|
25
31
|
# The metadata to use for the checkout configuration
|
|
26
32
|
#
|
|
@@ -62,7 +68,7 @@ module WhopSDK
|
|
|
62
68
|
# @return [String, nil]
|
|
63
69
|
required :redirect_url, String, nil?: true
|
|
64
70
|
|
|
65
|
-
# @!method initialize(id:, affiliate_code:, company_id:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
|
|
71
|
+
# @!method initialize(id:, affiliate_code:, company_id:, currency:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
|
|
66
72
|
# Some parameter documentations has been truncated, see
|
|
67
73
|
# {WhopSDK::Models::CheckoutConfiguration} for more details.
|
|
68
74
|
#
|
|
@@ -77,6 +83,8 @@ module WhopSDK
|
|
|
77
83
|
#
|
|
78
84
|
# @param company_id [String] The ID of the company to use for the checkout configuration
|
|
79
85
|
#
|
|
86
|
+
# @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
87
|
+
#
|
|
80
88
|
# @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
|
|
81
89
|
#
|
|
82
90
|
# @param mode [Symbol, WhopSDK::Models::CheckoutModes] The mode of the checkout session.
|
|
@@ -19,6 +19,12 @@ module WhopSDK
|
|
|
19
19
|
# @return [String, nil]
|
|
20
20
|
optional :affiliate_code, String, nil?: true
|
|
21
21
|
|
|
22
|
+
# @!attribute currency
|
|
23
|
+
# The available currencies on the platform
|
|
24
|
+
#
|
|
25
|
+
# @return [Symbol, WhopSDK::Models::Currency, nil]
|
|
26
|
+
optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
|
|
27
|
+
|
|
22
28
|
# @!attribute metadata
|
|
23
29
|
# The metadata to use for the checkout configuration
|
|
24
30
|
#
|
|
@@ -59,7 +65,7 @@ module WhopSDK
|
|
|
59
65
|
# @return [String]
|
|
60
66
|
required :company_id, String
|
|
61
67
|
|
|
62
|
-
# @!method initialize(plan:, plan_id:, company_id:, affiliate_code: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, mode: :setup, request_options: {})
|
|
68
|
+
# @!method initialize(plan:, plan_id:, company_id:, affiliate_code: nil, currency: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, mode: :setup, request_options: {})
|
|
63
69
|
# Some parameter documentations has been truncated, see
|
|
64
70
|
# {WhopSDK::Models::CheckoutConfigurationCreateParams} for more details.
|
|
65
71
|
#
|
|
@@ -71,6 +77,8 @@ module WhopSDK
|
|
|
71
77
|
#
|
|
72
78
|
# @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
|
|
73
79
|
#
|
|
80
|
+
# @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
81
|
+
#
|
|
74
82
|
# @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
|
|
75
83
|
#
|
|
76
84
|
# @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::PaymentMethodConfiguration, nil] This currently only works for configurations made in 'setup' mode. The explicit
|
|
@@ -22,6 +22,12 @@ module WhopSDK
|
|
|
22
22
|
# @return [String]
|
|
23
23
|
required :company_id, String
|
|
24
24
|
|
|
25
|
+
# @!attribute currency
|
|
26
|
+
# The available currencies on the platform
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, WhopSDK::Models::Currency, nil]
|
|
29
|
+
required :currency, enum: -> { WhopSDK::Currency }, nil?: true
|
|
30
|
+
|
|
25
31
|
# @!attribute metadata
|
|
26
32
|
# The metadata to use for the checkout configuration
|
|
27
33
|
#
|
|
@@ -63,7 +69,7 @@ module WhopSDK
|
|
|
63
69
|
# @return [String, nil]
|
|
64
70
|
required :redirect_url, String, nil?: true
|
|
65
71
|
|
|
66
|
-
# @!method initialize(id:, affiliate_code:, company_id:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
|
|
72
|
+
# @!method initialize(id:, affiliate_code:, company_id:, currency:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
|
|
67
73
|
# Some parameter documentations has been truncated, see
|
|
68
74
|
# {WhopSDK::Models::CheckoutConfigurationListResponse} for more details.
|
|
69
75
|
#
|
|
@@ -78,6 +84,8 @@ module WhopSDK
|
|
|
78
84
|
#
|
|
79
85
|
# @param company_id [String] The ID of the company to use for the checkout configuration
|
|
80
86
|
#
|
|
87
|
+
# @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
88
|
+
#
|
|
81
89
|
# @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
|
|
82
90
|
#
|
|
83
91
|
# @param mode [Symbol, WhopSDK::Models::CheckoutModes] The mode of the checkout session.
|
|
@@ -70,6 +70,12 @@ module WhopSDK
|
|
|
70
70
|
# @return [String]
|
|
71
71
|
required :route, String
|
|
72
72
|
|
|
73
|
+
# @!attribute send_customer_emails
|
|
74
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
75
|
+
#
|
|
76
|
+
# @return [Boolean]
|
|
77
|
+
required :send_customer_emails, WhopSDK::Internal::Type::Boolean
|
|
78
|
+
|
|
73
79
|
# @!attribute social_links
|
|
74
80
|
# The social media accounts of the company
|
|
75
81
|
#
|
|
@@ -94,7 +100,7 @@ module WhopSDK
|
|
|
94
100
|
# @return [Boolean]
|
|
95
101
|
required :verified, WhopSDK::Internal::Type::Boolean
|
|
96
102
|
|
|
97
|
-
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, social_links:, title:, updated_at:, verified:)
|
|
103
|
+
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, send_customer_emails:, social_links:, title:, updated_at:, verified:)
|
|
98
104
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Company}
|
|
99
105
|
# for more details.
|
|
100
106
|
#
|
|
@@ -122,6 +128,8 @@ module WhopSDK
|
|
|
122
128
|
#
|
|
123
129
|
# @param route [String] The slug/route of the company on the Whop site.
|
|
124
130
|
#
|
|
131
|
+
# @param send_customer_emails [Boolean] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
132
|
+
#
|
|
125
133
|
# @param social_links [Array<WhopSDK::Models::Company::SocialLink>] The social media accounts of the company
|
|
126
134
|
#
|
|
127
135
|
# @param title [String] The title of the company.
|
|
@@ -31,7 +31,19 @@ module WhopSDK
|
|
|
31
31
|
# @return [Hash{Symbol=>Object}, nil]
|
|
32
32
|
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
33
33
|
|
|
34
|
-
# @!
|
|
34
|
+
# @!attribute send_customer_emails
|
|
35
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
36
|
+
# Includes: order confirmations, payment failures, refund notifications, upcoming
|
|
37
|
+
# renewals, and membership cancelations/expirations. When disabled, the platform
|
|
38
|
+
# is responsible for handling these communications. This is defaulted to true.
|
|
39
|
+
#
|
|
40
|
+
# @return [Boolean, nil]
|
|
41
|
+
optional :send_customer_emails, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!method initialize(email:, parent_company_id:, title:, metadata: nil, send_customer_emails: nil, request_options: {})
|
|
44
|
+
# Some parameter documentations has been truncated, see
|
|
45
|
+
# {WhopSDK::Models::CompanyCreateParams} for more details.
|
|
46
|
+
#
|
|
35
47
|
# @param email [String] The email of the user who the company will belong to.
|
|
36
48
|
#
|
|
37
49
|
# @param parent_company_id [String] The company ID of the platform creating this company.
|
|
@@ -40,6 +52,8 @@ module WhopSDK
|
|
|
40
52
|
#
|
|
41
53
|
# @param metadata [Hash{Symbol=>Object}, nil] Additional metadata for the account
|
|
42
54
|
#
|
|
55
|
+
# @param send_customer_emails [Boolean, nil] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
56
|
+
#
|
|
43
57
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
44
58
|
end
|
|
45
59
|
end
|
|
@@ -71,6 +71,12 @@ module WhopSDK
|
|
|
71
71
|
# @return [String]
|
|
72
72
|
required :route, String
|
|
73
73
|
|
|
74
|
+
# @!attribute send_customer_emails
|
|
75
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
76
|
+
#
|
|
77
|
+
# @return [Boolean]
|
|
78
|
+
required :send_customer_emails, WhopSDK::Internal::Type::Boolean
|
|
79
|
+
|
|
74
80
|
# @!attribute title
|
|
75
81
|
# The title of the company.
|
|
76
82
|
#
|
|
@@ -89,7 +95,7 @@ module WhopSDK
|
|
|
89
95
|
# @return [Boolean]
|
|
90
96
|
required :verified, WhopSDK::Internal::Type::Boolean
|
|
91
97
|
|
|
92
|
-
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, title:, updated_at:, verified:)
|
|
98
|
+
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, send_customer_emails:, title:, updated_at:, verified:)
|
|
93
99
|
# Some parameter documentations has been truncated, see
|
|
94
100
|
# {WhopSDK::Models::CompanyListResponse} for more details.
|
|
95
101
|
#
|
|
@@ -117,6 +123,8 @@ module WhopSDK
|
|
|
117
123
|
#
|
|
118
124
|
# @param route [String] The slug/route of the company on the Whop site.
|
|
119
125
|
#
|
|
126
|
+
# @param send_customer_emails [Boolean] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
127
|
+
#
|
|
120
128
|
# @param title [String] The title of the company.
|
|
121
129
|
#
|
|
122
130
|
# @param updated_at [Time] The time the company was last updated.
|
|
@@ -13,15 +13,29 @@ module WhopSDK
|
|
|
13
13
|
# @return [WhopSDK::Models::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::CompanyUpdateParams::Logo::AttachmentInputWithID, nil]
|
|
14
14
|
optional :logo, union: -> { WhopSDK::CompanyUpdateParams::Logo }, nil?: true
|
|
15
15
|
|
|
16
|
+
# @!attribute send_customer_emails
|
|
17
|
+
# Whether Whop sends transactional emails to customers on behalf of this company.
|
|
18
|
+
# Includes: order confirmations, payment failures, refund notifications, upcoming
|
|
19
|
+
# renewals, and membership cancelations/expirations. When disabled, the platform
|
|
20
|
+
# is responsible for handling these communications.
|
|
21
|
+
#
|
|
22
|
+
# @return [Boolean, nil]
|
|
23
|
+
optional :send_customer_emails, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
24
|
+
|
|
16
25
|
# @!attribute title
|
|
17
26
|
# The title of the company
|
|
18
27
|
#
|
|
19
28
|
# @return [String, nil]
|
|
20
29
|
optional :title, String, nil?: true
|
|
21
30
|
|
|
22
|
-
# @!method initialize(logo: nil, title: nil, request_options: {})
|
|
31
|
+
# @!method initialize(logo: nil, send_customer_emails: nil, title: nil, request_options: {})
|
|
32
|
+
# Some parameter documentations has been truncated, see
|
|
33
|
+
# {WhopSDK::Models::CompanyUpdateParams} for more details.
|
|
34
|
+
#
|
|
23
35
|
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::CompanyUpdateParams::Logo::AttachmentInputWithID, nil] The logo for the company in png, jpeg, or gif format
|
|
24
36
|
#
|
|
37
|
+
# @param send_customer_emails [Boolean, nil] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
38
|
+
#
|
|
25
39
|
# @param title [String, nil] The title of the company
|
|
26
40
|
#
|
|
27
41
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -33,6 +33,12 @@ module WhopSDK
|
|
|
33
33
|
# @return [WhopSDK::Models::Experience::Image, nil]
|
|
34
34
|
required :image, -> { WhopSDK::Experience::Image }, nil?: true
|
|
35
35
|
|
|
36
|
+
# @!attribute is_public
|
|
37
|
+
# Whether the experience is visible to the public
|
|
38
|
+
#
|
|
39
|
+
# @return [Boolean]
|
|
40
|
+
required :is_public, WhopSDK::Internal::Type::Boolean
|
|
41
|
+
|
|
36
42
|
# @!attribute name
|
|
37
43
|
# The written name of the description.
|
|
38
44
|
#
|
|
@@ -53,7 +59,7 @@ module WhopSDK
|
|
|
53
59
|
# @return [Array<WhopSDK::Models::Experience::Product>]
|
|
54
60
|
required :products, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Experience::Product] }
|
|
55
61
|
|
|
56
|
-
# @!method initialize(id:, app:, company:, created_at:, image:, name:, order:, products:)
|
|
62
|
+
# @!method initialize(id:, app:, company:, created_at:, image:, is_public:, name:, order:, products:)
|
|
57
63
|
# Some parameter documentations has been truncated, see
|
|
58
64
|
# {WhopSDK::Models::Experience} for more details.
|
|
59
65
|
#
|
|
@@ -69,6 +75,8 @@ module WhopSDK
|
|
|
69
75
|
#
|
|
70
76
|
# @param image [WhopSDK::Models::Experience::Image, nil] The logo for the experience.
|
|
71
77
|
#
|
|
78
|
+
# @param is_public [Boolean] Whether the experience is visible to the public
|
|
79
|
+
#
|
|
72
80
|
# @param name [String] The written name of the description.
|
|
73
81
|
#
|
|
74
82
|
# @param order [String, nil] The order of the experience in the section
|
|
@@ -19,6 +19,12 @@ module WhopSDK
|
|
|
19
19
|
# @return [String]
|
|
20
20
|
required :company_id, String
|
|
21
21
|
|
|
22
|
+
# @!attribute is_public
|
|
23
|
+
# Whether the experience is publicly accessible
|
|
24
|
+
#
|
|
25
|
+
# @return [Boolean, nil]
|
|
26
|
+
optional :is_public, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
27
|
+
|
|
22
28
|
# @!attribute name
|
|
23
29
|
# The name of the experience
|
|
24
30
|
#
|
|
@@ -31,11 +37,13 @@ module WhopSDK
|
|
|
31
37
|
# @return [String, nil]
|
|
32
38
|
optional :section_id, String, nil?: true
|
|
33
39
|
|
|
34
|
-
# @!method initialize(app_id:, company_id:, name: nil, section_id: nil, request_options: {})
|
|
40
|
+
# @!method initialize(app_id:, company_id:, is_public: nil, name: nil, section_id: nil, request_options: {})
|
|
35
41
|
# @param app_id [String] The ID of the app to create the experience for
|
|
36
42
|
#
|
|
37
43
|
# @param company_id [String] The ID of the company to create the experience for
|
|
38
44
|
#
|
|
45
|
+
# @param is_public [Boolean, nil] Whether the experience is publicly accessible
|
|
46
|
+
#
|
|
39
47
|
# @param name [String, nil] The name of the experience
|
|
40
48
|
#
|
|
41
49
|
# @param section_id [String, nil] The ID of the section to create the experience in
|
|
@@ -34,6 +34,12 @@ module WhopSDK
|
|
|
34
34
|
# @return [WhopSDK::Models::ExperienceListResponse::Image, nil]
|
|
35
35
|
required :image, -> { WhopSDK::Models::ExperienceListResponse::Image }, nil?: true
|
|
36
36
|
|
|
37
|
+
# @!attribute is_public
|
|
38
|
+
# Whether the experience is visible to the public
|
|
39
|
+
#
|
|
40
|
+
# @return [Boolean]
|
|
41
|
+
required :is_public, WhopSDK::Internal::Type::Boolean
|
|
42
|
+
|
|
37
43
|
# @!attribute name
|
|
38
44
|
# The written name of the description.
|
|
39
45
|
#
|
|
@@ -46,7 +52,7 @@ module WhopSDK
|
|
|
46
52
|
# @return [String, nil]
|
|
47
53
|
required :order, String, nil?: true
|
|
48
54
|
|
|
49
|
-
# @!method initialize(id:, app:, company:, created_at:, image:, name:, order:)
|
|
55
|
+
# @!method initialize(id:, app:, company:, created_at:, image:, is_public:, name:, order:)
|
|
50
56
|
# An object representing an experience belonging to a company.
|
|
51
57
|
#
|
|
52
58
|
# @param id [String] The unique ID representing this experience
|
|
@@ -59,6 +65,8 @@ module WhopSDK
|
|
|
59
65
|
#
|
|
60
66
|
# @param image [WhopSDK::Models::ExperienceListResponse::Image, nil] The logo for the experience.
|
|
61
67
|
#
|
|
68
|
+
# @param is_public [Boolean] Whether the experience is visible to the public
|
|
69
|
+
#
|
|
62
70
|
# @param name [String] The written name of the description.
|
|
63
71
|
#
|
|
64
72
|
# @param order [String, nil] The order of the experience in the section
|
|
@@ -13,6 +13,12 @@ module WhopSDK
|
|
|
13
13
|
# @return [Symbol, WhopSDK::Models::ExperienceUpdateParams::AccessLevel, nil]
|
|
14
14
|
optional :access_level, enum: -> { WhopSDK::ExperienceUpdateParams::AccessLevel }, nil?: true
|
|
15
15
|
|
|
16
|
+
# @!attribute is_public
|
|
17
|
+
# Whether the experience is publicly accessible.
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :is_public, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
21
|
+
|
|
16
22
|
# @!attribute logo
|
|
17
23
|
# The logo for the experience
|
|
18
24
|
#
|
|
@@ -37,9 +43,11 @@ module WhopSDK
|
|
|
37
43
|
# @return [String, nil]
|
|
38
44
|
optional :section_id, String, nil?: true
|
|
39
45
|
|
|
40
|
-
# @!method initialize(access_level: nil, logo: nil, name: nil, order: nil, section_id: nil, request_options: {})
|
|
46
|
+
# @!method initialize(access_level: nil, is_public: nil, logo: nil, name: nil, order: nil, section_id: nil, request_options: {})
|
|
41
47
|
# @param access_level [Symbol, WhopSDK::Models::ExperienceUpdateParams::AccessLevel, nil] The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
|
|
42
48
|
#
|
|
49
|
+
# @param is_public [Boolean, nil] Whether the experience is publicly accessible.
|
|
50
|
+
#
|
|
43
51
|
# @param logo [WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithID, nil] The logo for the experience
|
|
44
52
|
#
|
|
45
53
|
# @param name [String, nil] The name of the experience.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::FeeMarkups#create
|
|
6
|
+
class FeeMarkupCreateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute company_id
|
|
11
|
+
# The ID (tag) of the company you want to update the fee markup for.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :company_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute fee_type
|
|
17
|
+
# The type of fee this markup applies to.
|
|
18
|
+
#
|
|
19
|
+
# @return [Symbol, WhopSDK::Models::FeeMarkupType]
|
|
20
|
+
required :fee_type, enum: -> { WhopSDK::FeeMarkupType }
|
|
21
|
+
|
|
22
|
+
# @!attribute fixed_fee_usd
|
|
23
|
+
# The fixed fee in USD to charge (0-50).
|
|
24
|
+
#
|
|
25
|
+
# @return [Float, nil]
|
|
26
|
+
optional :fixed_fee_usd, Float, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute metadata
|
|
29
|
+
# Custom metadata to attach to this fee markup.
|
|
30
|
+
#
|
|
31
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
32
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute notes
|
|
35
|
+
# Internal notes about this fee markup.
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :notes, String, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!attribute percentage_fee
|
|
41
|
+
# The percentage fee to charge (0-25).
|
|
42
|
+
#
|
|
43
|
+
# @return [Float, nil]
|
|
44
|
+
optional :percentage_fee, Float, nil?: true
|
|
45
|
+
|
|
46
|
+
# @!method initialize(company_id:, fee_type:, fixed_fee_usd: nil, metadata: nil, notes: nil, percentage_fee: nil, request_options: {})
|
|
47
|
+
# @param company_id [String] The ID (tag) of the company you want to update the fee markup for.
|
|
48
|
+
#
|
|
49
|
+
# @param fee_type [Symbol, WhopSDK::Models::FeeMarkupType] The type of fee this markup applies to.
|
|
50
|
+
#
|
|
51
|
+
# @param fixed_fee_usd [Float, nil] The fixed fee in USD to charge (0-50).
|
|
52
|
+
#
|
|
53
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom metadata to attach to this fee markup.
|
|
54
|
+
#
|
|
55
|
+
# @param notes [String, nil] Internal notes about this fee markup.
|
|
56
|
+
#
|
|
57
|
+
# @param percentage_fee [Float, nil] The percentage fee to charge (0-25).
|
|
58
|
+
#
|
|
59
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::FeeMarkups#create
|
|
6
|
+
class FeeMarkupCreateResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique identifier of the fee markup.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# When this fee markup was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Time]
|
|
17
|
+
required :created_at, Time
|
|
18
|
+
|
|
19
|
+
# @!attribute fee_type
|
|
20
|
+
# The type of fee this markup applies to.
|
|
21
|
+
#
|
|
22
|
+
# @return [Symbol, WhopSDK::Models::FeeMarkupType]
|
|
23
|
+
required :fee_type, enum: -> { WhopSDK::FeeMarkupType }
|
|
24
|
+
|
|
25
|
+
# @!attribute fixed_fee_usd
|
|
26
|
+
# The fixed fee in USD to charge (0-50).
|
|
27
|
+
#
|
|
28
|
+
# @return [Float, nil]
|
|
29
|
+
required :fixed_fee_usd, Float, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!attribute notes
|
|
32
|
+
# Internal notes about this fee markup.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
required :notes, String, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!attribute percentage_fee
|
|
38
|
+
# The percentage fee to charge (0-25).
|
|
39
|
+
#
|
|
40
|
+
# @return [Float, nil]
|
|
41
|
+
required :percentage_fee, Float, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!attribute updated_at
|
|
44
|
+
# When this fee markup was last updated.
|
|
45
|
+
#
|
|
46
|
+
# @return [Time]
|
|
47
|
+
required :updated_at, Time
|
|
48
|
+
|
|
49
|
+
# @!method initialize(id:, created_at:, fee_type:, fixed_fee_usd:, notes:, percentage_fee:, updated_at:)
|
|
50
|
+
# Represents a fee markup configuration for a company
|
|
51
|
+
#
|
|
52
|
+
# @param id [String] The unique identifier of the fee markup.
|
|
53
|
+
#
|
|
54
|
+
# @param created_at [Time] When this fee markup was created.
|
|
55
|
+
#
|
|
56
|
+
# @param fee_type [Symbol, WhopSDK::Models::FeeMarkupType] The type of fee this markup applies to.
|
|
57
|
+
#
|
|
58
|
+
# @param fixed_fee_usd [Float, nil] The fixed fee in USD to charge (0-50).
|
|
59
|
+
#
|
|
60
|
+
# @param notes [String, nil] Internal notes about this fee markup.
|
|
61
|
+
#
|
|
62
|
+
# @param percentage_fee [Float, nil] The percentage fee to charge (0-25).
|
|
63
|
+
#
|
|
64
|
+
# @param updated_at [Time] When this fee markup was last updated.
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::FeeMarkups#delete
|
|
6
|
+
class FeeMarkupDeleteParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::FeeMarkups#list
|
|
6
|
+
class FeeMarkupListParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute company_id
|
|
11
|
+
# The ID (tag) of the company you want to list the fee markups for. If you pass
|
|
12
|
+
# your platform account, you will get the platform default markups.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :company_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute after
|
|
18
|
+
# Returns the elements in the list that come after the specified cursor.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :after, String, nil?: true
|
|
22
|
+
|
|
23
|
+
# @!attribute before
|
|
24
|
+
# Returns the elements in the list that come before the specified cursor.
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :before, String, nil?: true
|
|
28
|
+
|
|
29
|
+
# @!attribute first
|
|
30
|
+
# Returns the first _n_ elements from the list.
|
|
31
|
+
#
|
|
32
|
+
# @return [Integer, nil]
|
|
33
|
+
optional :first, Integer, nil?: true
|
|
34
|
+
|
|
35
|
+
# @!attribute last
|
|
36
|
+
# Returns the last _n_ elements from the list.
|
|
37
|
+
#
|
|
38
|
+
# @return [Integer, nil]
|
|
39
|
+
optional :last, Integer, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!method initialize(company_id:, after: nil, before: nil, first: nil, last: nil, request_options: {})
|
|
42
|
+
# Some parameter documentations has been truncated, see
|
|
43
|
+
# {WhopSDK::Models::FeeMarkupListParams} for more details.
|
|
44
|
+
#
|
|
45
|
+
# @param company_id [String] The ID (tag) of the company you want to list the fee markups for. If you pass yo
|
|
46
|
+
#
|
|
47
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
48
|
+
#
|
|
49
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
50
|
+
#
|
|
51
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
52
|
+
#
|
|
53
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
54
|
+
#
|
|
55
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|