whop_sdk 0.0.29 → 0.0.30
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 +8 -0
- data/README.md +1 -1
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +1 -25
- data/lib/whop_sdk/models/company.rb +1 -17
- data/lib/whop_sdk/models/company_create_params.rb +1 -25
- data/lib/whop_sdk/models/company_list_response.rb +1 -17
- data/lib/whop_sdk/models/company_update_params.rb +1 -25
- data/lib/whop_sdk/models/payment_create_params.rb +1 -25
- data/lib/whop_sdk/models/product.rb +1 -17
- data/lib/whop_sdk/models/product_create_params.rb +1 -25
- data/lib/whop_sdk/models/product_list_item.rb +1 -17
- data/lib/whop_sdk/models/product_update_params.rb +1 -25
- data/lib/whop_sdk/models.rb +0 -6
- data/lib/whop_sdk/resources/companies.rb +2 -14
- data/lib/whop_sdk/resources/products.rb +2 -14
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +0 -3
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +0 -24
- data/rbi/whop_sdk/models/company.rbi +0 -16
- data/rbi/whop_sdk/models/company_create_params.rbi +0 -24
- data/rbi/whop_sdk/models/company_list_response.rbi +0 -16
- data/rbi/whop_sdk/models/company_update_params.rbi +0 -24
- data/rbi/whop_sdk/models/payment_create_params.rbi +0 -24
- data/rbi/whop_sdk/models/product.rbi +0 -16
- data/rbi/whop_sdk/models/product_create_params.rbi +0 -24
- data/rbi/whop_sdk/models/product_list_item.rbi +0 -16
- data/rbi/whop_sdk/models/product_update_params.rbi +0 -24
- data/rbi/whop_sdk/models.rbi +0 -6
- data/rbi/whop_sdk/resources/companies.rbi +0 -18
- data/rbi/whop_sdk/resources/products.rbi +0 -18
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +0 -15
- data/sig/whop_sdk/models/company.rbs +0 -10
- data/sig/whop_sdk/models/company_create_params.rbs +0 -15
- data/sig/whop_sdk/models/company_list_response.rbs +0 -10
- data/sig/whop_sdk/models/company_update_params.rbs +0 -15
- data/sig/whop_sdk/models/payment_create_params.rbs +0 -15
- data/sig/whop_sdk/models/product.rbs +0 -10
- data/sig/whop_sdk/models/product_create_params.rbs +0 -15
- data/sig/whop_sdk/models/product_list_item.rbs +0 -10
- data/sig/whop_sdk/models/product_update_params.rbs +0 -15
- data/sig/whop_sdk/models.rbs +0 -6
- data/sig/whop_sdk/resources/companies.rbs +0 -6
- data/sig/whop_sdk/resources/products.rbs +0 -6
- metadata +2 -11
- data/lib/whop_sdk/models/business_types.rb +0 -34
- data/lib/whop_sdk/models/industry_groups.rb +0 -152
- data/lib/whop_sdk/models/industry_types.rb +0 -1954
- data/rbi/whop_sdk/models/business_types.rbi +0 -44
- data/rbi/whop_sdk/models/industry_groups.rbi +0 -434
- data/rbi/whop_sdk/models/industry_types.rbi +0 -3969
- data/sig/whop_sdk/models/business_types.rbs +0 -52
- data/sig/whop_sdk/models/industry_groups.rbs +0 -288
- data/sig/whop_sdk/models/industry_types.rbs +0 -3892
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 256eab8a7571e6e50eccaa978cd2621dffc4ed5b79d248a40e422eb0996807df
|
|
4
|
+
data.tar.gz: 9c7e0ad9057850a02e034b28dd68209e3174ab3a1cd56e306fff1da3b332b575
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9546368ed22a74a32a48566984f1cc897ddea29950dcdc0374d26a7583dc954d7807cef826ca5264530d18ac4f52a5c4cc381211bb12a1c87f93c46dc5ce42d9
|
|
7
|
+
data.tar.gz: 1b127979a24272355a5c0066ecf7fc7ad68465a1a2374c1e34e9ec4334d4fb2a7a24a43cfa890e3215c9fea82e50e1150b0dbbb950d679273638dfc33421f1f8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.0.30 (2026-02-26)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.0.29...v0.0.30](https://github.com/whopio/whopsdk-ruby/compare/v0.0.29...v0.0.30)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([3f7e9d3](https://github.com/whopio/whopsdk-ruby/commit/3f7e9d36e89fb3e612d254d6b1683acd1bf57f19))
|
|
10
|
+
|
|
3
11
|
## 0.0.29 (2026-02-25)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.0.28...v0.0.29](https://github.com/whopio/whopsdk-ruby/compare/v0.0.28...v0.0.29)
|
data/README.md
CHANGED
|
@@ -427,12 +427,6 @@ module WhopSDK
|
|
|
427
427
|
# @return [String]
|
|
428
428
|
required :title, String
|
|
429
429
|
|
|
430
|
-
# @!attribute business_type
|
|
431
|
-
# The different business types a company can be.
|
|
432
|
-
#
|
|
433
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
434
|
-
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
435
|
-
|
|
436
430
|
# @!attribute collect_shipping_address
|
|
437
431
|
# Whether or not to collect shipping information at checkout from the customer.
|
|
438
432
|
#
|
|
@@ -471,18 +465,6 @@ module WhopSDK
|
|
|
471
465
|
# @return [String, nil]
|
|
472
466
|
optional :headline, String, nil?: true
|
|
473
467
|
|
|
474
|
-
# @!attribute industry_group
|
|
475
|
-
# The different industry groups a company can be in.
|
|
476
|
-
#
|
|
477
|
-
# @return [Symbol, WhopSDK::Models::IndustryGroups, nil]
|
|
478
|
-
optional :industry_group, enum: -> { WhopSDK::IndustryGroups }, nil?: true
|
|
479
|
-
|
|
480
|
-
# @!attribute industry_type
|
|
481
|
-
# The different industry types a company can be in.
|
|
482
|
-
#
|
|
483
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
484
|
-
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
485
|
-
|
|
486
468
|
# @!attribute product_tax_code_id
|
|
487
469
|
# The ID of the product tax code to apply to this product.
|
|
488
470
|
#
|
|
@@ -507,7 +489,7 @@ module WhopSDK
|
|
|
507
489
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
508
490
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
509
491
|
|
|
510
|
-
# @!method initialize(external_identifier:, title:,
|
|
492
|
+
# @!method initialize(external_identifier:, title:, collect_shipping_address: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil)
|
|
511
493
|
# Some parameter documentations has been truncated, see
|
|
512
494
|
# {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Product} for more
|
|
513
495
|
# details.
|
|
@@ -519,8 +501,6 @@ module WhopSDK
|
|
|
519
501
|
#
|
|
520
502
|
# @param title [String] The title of the product.
|
|
521
503
|
#
|
|
522
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
523
|
-
#
|
|
524
504
|
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
525
505
|
#
|
|
526
506
|
# @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
|
|
@@ -534,10 +514,6 @@ module WhopSDK
|
|
|
534
514
|
#
|
|
535
515
|
# @param headline [String, nil] The headline of the product.
|
|
536
516
|
#
|
|
537
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
538
|
-
#
|
|
539
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
540
|
-
#
|
|
541
517
|
# @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
|
|
542
518
|
#
|
|
543
519
|
# @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
|
|
@@ -9,12 +9,6 @@ module WhopSDK
|
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
11
11
|
|
|
12
|
-
# @!attribute business_type
|
|
13
|
-
# The different business types a company can be.
|
|
14
|
-
#
|
|
15
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
16
|
-
required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
17
|
-
|
|
18
12
|
# @!attribute created_at
|
|
19
13
|
# The datetime the company was created.
|
|
20
14
|
#
|
|
@@ -28,12 +22,6 @@ module WhopSDK
|
|
|
28
22
|
# @return [String, nil]
|
|
29
23
|
required :description, String, nil?: true
|
|
30
24
|
|
|
31
|
-
# @!attribute industry_type
|
|
32
|
-
# The different industry types a company can be in.
|
|
33
|
-
#
|
|
34
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
35
|
-
required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
36
|
-
|
|
37
25
|
# @!attribute logo
|
|
38
26
|
# The company's logo.
|
|
39
27
|
#
|
|
@@ -105,7 +93,7 @@ module WhopSDK
|
|
|
105
93
|
# @return [Boolean]
|
|
106
94
|
required :verified, WhopSDK::Internal::Type::Boolean
|
|
107
95
|
|
|
108
|
-
# @!method initialize(id:,
|
|
96
|
+
# @!method initialize(id:, created_at:, description:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, send_customer_emails:, social_links:, title:, updated_at:, verified:)
|
|
109
97
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Company}
|
|
110
98
|
# for more details.
|
|
111
99
|
#
|
|
@@ -114,14 +102,10 @@ module WhopSDK
|
|
|
114
102
|
#
|
|
115
103
|
# @param id [String] The unique identifier for the company.
|
|
116
104
|
#
|
|
117
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
118
|
-
#
|
|
119
105
|
# @param created_at [Time] The datetime the company was created.
|
|
120
106
|
#
|
|
121
107
|
# @param description [String, nil] A promotional pitch written by the company creator, displayed to potential custo
|
|
122
108
|
#
|
|
123
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
124
|
-
#
|
|
125
109
|
# @param logo [WhopSDK::Models::Company::Logo, nil] The company's logo.
|
|
126
110
|
#
|
|
127
111
|
# @param member_count [Integer] The total number of users who currently hold active memberships across all of th
|
|
@@ -13,12 +13,6 @@ module WhopSDK
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :title, String
|
|
15
15
|
|
|
16
|
-
# @!attribute business_type
|
|
17
|
-
# The different business types a company can be.
|
|
18
|
-
#
|
|
19
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
20
|
-
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
21
|
-
|
|
22
16
|
# @!attribute description
|
|
23
17
|
# A promotional pitch displayed to potential customers on the company's store
|
|
24
18
|
# page.
|
|
@@ -33,18 +27,6 @@ module WhopSDK
|
|
|
33
27
|
# @return [String, nil]
|
|
34
28
|
optional :email, String, nil?: true
|
|
35
29
|
|
|
36
|
-
# @!attribute industry_group
|
|
37
|
-
# The different industry groups a company can be in.
|
|
38
|
-
#
|
|
39
|
-
# @return [Symbol, WhopSDK::Models::IndustryGroups, nil]
|
|
40
|
-
optional :industry_group, enum: -> { WhopSDK::IndustryGroups }, nil?: true
|
|
41
|
-
|
|
42
|
-
# @!attribute industry_type
|
|
43
|
-
# The different industry types a company can be in.
|
|
44
|
-
#
|
|
45
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
46
|
-
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
47
|
-
|
|
48
30
|
# @!attribute logo
|
|
49
31
|
# The company's logo image. Accepts PNG, JPEG, or GIF format.
|
|
50
32
|
#
|
|
@@ -72,22 +54,16 @@ module WhopSDK
|
|
|
72
54
|
# @return [Boolean, nil]
|
|
73
55
|
optional :send_customer_emails, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
74
56
|
|
|
75
|
-
# @!method initialize(title:,
|
|
57
|
+
# @!method initialize(title:, description: nil, email: nil, logo: nil, metadata: nil, parent_company_id: nil, send_customer_emails: nil, request_options: {})
|
|
76
58
|
# Some parameter documentations has been truncated, see
|
|
77
59
|
# {WhopSDK::Models::CompanyCreateParams} for more details.
|
|
78
60
|
#
|
|
79
61
|
# @param title [String] The display name of the company shown to customers.
|
|
80
62
|
#
|
|
81
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
82
|
-
#
|
|
83
63
|
# @param description [String, nil] A promotional pitch displayed to potential customers on the company's store page
|
|
84
64
|
#
|
|
85
65
|
# @param email [String, nil] The email address of the user who will own the connected account. Required when
|
|
86
66
|
#
|
|
87
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
88
|
-
#
|
|
89
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
90
|
-
#
|
|
91
67
|
# @param logo [WhopSDK::Models::CompanyCreateParams::Logo, nil] The company's logo image. Accepts PNG, JPEG, or GIF format.
|
|
92
68
|
#
|
|
93
69
|
# @param metadata [Hash{Symbol=>Object}, nil] A key-value JSON object of custom metadata to store on the company.
|
|
@@ -10,12 +10,6 @@ module WhopSDK
|
|
|
10
10
|
# @return [String]
|
|
11
11
|
required :id, String
|
|
12
12
|
|
|
13
|
-
# @!attribute business_type
|
|
14
|
-
# The different business types a company can be.
|
|
15
|
-
#
|
|
16
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
17
|
-
required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
18
|
-
|
|
19
13
|
# @!attribute created_at
|
|
20
14
|
# The datetime the company was created.
|
|
21
15
|
#
|
|
@@ -29,12 +23,6 @@ module WhopSDK
|
|
|
29
23
|
# @return [String, nil]
|
|
30
24
|
required :description, String, nil?: true
|
|
31
25
|
|
|
32
|
-
# @!attribute industry_type
|
|
33
|
-
# The different industry types a company can be in.
|
|
34
|
-
#
|
|
35
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
36
|
-
required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
37
|
-
|
|
38
26
|
# @!attribute logo
|
|
39
27
|
# The company's logo.
|
|
40
28
|
#
|
|
@@ -99,7 +87,7 @@ module WhopSDK
|
|
|
99
87
|
# @return [Boolean]
|
|
100
88
|
required :verified, WhopSDK::Internal::Type::Boolean
|
|
101
89
|
|
|
102
|
-
# @!method initialize(id:,
|
|
90
|
+
# @!method initialize(id:, created_at:, description:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, send_customer_emails:, title:, updated_at:, verified:)
|
|
103
91
|
# Some parameter documentations has been truncated, see
|
|
104
92
|
# {WhopSDK::Models::CompanyListResponse} for more details.
|
|
105
93
|
#
|
|
@@ -108,14 +96,10 @@ module WhopSDK
|
|
|
108
96
|
#
|
|
109
97
|
# @param id [String] The unique identifier for the company.
|
|
110
98
|
#
|
|
111
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
112
|
-
#
|
|
113
99
|
# @param created_at [Time] The datetime the company was created.
|
|
114
100
|
#
|
|
115
101
|
# @param description [String, nil] A promotional pitch written by the company creator, displayed to potential custo
|
|
116
102
|
#
|
|
117
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
118
|
-
#
|
|
119
103
|
# @param logo [WhopSDK::Models::CompanyListResponse::Logo, nil] The company's logo.
|
|
120
104
|
#
|
|
121
105
|
# @param member_count [Integer] The total number of users who currently hold active memberships across all of th
|
|
@@ -13,12 +13,6 @@ module WhopSDK
|
|
|
13
13
|
# @return [WhopSDK::Models::CompanyUpdateParams::BannerImage, nil]
|
|
14
14
|
optional :banner_image, -> { WhopSDK::CompanyUpdateParams::BannerImage }, nil?: true
|
|
15
15
|
|
|
16
|
-
# @!attribute business_type
|
|
17
|
-
# The different business types a company can be.
|
|
18
|
-
#
|
|
19
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
20
|
-
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
21
|
-
|
|
22
16
|
# @!attribute description
|
|
23
17
|
# A promotional pitch displayed to potential customers on the company's store
|
|
24
18
|
# page.
|
|
@@ -26,18 +20,6 @@ module WhopSDK
|
|
|
26
20
|
# @return [String, nil]
|
|
27
21
|
optional :description, String, nil?: true
|
|
28
22
|
|
|
29
|
-
# @!attribute industry_group
|
|
30
|
-
# The different industry groups a company can be in.
|
|
31
|
-
#
|
|
32
|
-
# @return [Symbol, WhopSDK::Models::IndustryGroups, nil]
|
|
33
|
-
optional :industry_group, enum: -> { WhopSDK::IndustryGroups }, nil?: true
|
|
34
|
-
|
|
35
|
-
# @!attribute industry_type
|
|
36
|
-
# The different industry types a company can be in.
|
|
37
|
-
#
|
|
38
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
39
|
-
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
40
|
-
|
|
41
23
|
# @!attribute logo
|
|
42
24
|
# The company's logo image. Accepts PNG, JPEG, or GIF format.
|
|
43
25
|
#
|
|
@@ -72,20 +54,14 @@ module WhopSDK
|
|
|
72
54
|
# @return [String, nil]
|
|
73
55
|
optional :title, String, nil?: true
|
|
74
56
|
|
|
75
|
-
# @!method initialize(banner_image: nil,
|
|
57
|
+
# @!method initialize(banner_image: nil, description: nil, logo: nil, route: nil, send_customer_emails: nil, target_audience: nil, title: nil, request_options: {})
|
|
76
58
|
# Some parameter documentations has been truncated, see
|
|
77
59
|
# {WhopSDK::Models::CompanyUpdateParams} for more details.
|
|
78
60
|
#
|
|
79
61
|
# @param banner_image [WhopSDK::Models::CompanyUpdateParams::BannerImage, nil] The company's banner image. Accepts PNG or JPEG format.
|
|
80
62
|
#
|
|
81
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
82
|
-
#
|
|
83
63
|
# @param description [String, nil] A promotional pitch displayed to potential customers on the company's store page
|
|
84
64
|
#
|
|
85
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
86
|
-
#
|
|
87
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
88
|
-
#
|
|
89
65
|
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo, nil] The company's logo image. Accepts PNG, JPEG, or GIF format.
|
|
90
66
|
#
|
|
91
67
|
# @param route [String, nil] The unique URL slug for the company's store page. Must be lowercase and can incl
|
|
@@ -203,12 +203,6 @@ module WhopSDK
|
|
|
203
203
|
# @return [String]
|
|
204
204
|
required :title, String
|
|
205
205
|
|
|
206
|
-
# @!attribute business_type
|
|
207
|
-
# The different business types a company can be.
|
|
208
|
-
#
|
|
209
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
210
|
-
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
211
|
-
|
|
212
206
|
# @!attribute collect_shipping_address
|
|
213
207
|
# Whether or not to collect shipping information at checkout from the customer.
|
|
214
208
|
#
|
|
@@ -247,18 +241,6 @@ module WhopSDK
|
|
|
247
241
|
# @return [String, nil]
|
|
248
242
|
optional :headline, String, nil?: true
|
|
249
243
|
|
|
250
|
-
# @!attribute industry_group
|
|
251
|
-
# The different industry groups a company can be in.
|
|
252
|
-
#
|
|
253
|
-
# @return [Symbol, WhopSDK::Models::IndustryGroups, nil]
|
|
254
|
-
optional :industry_group, enum: -> { WhopSDK::IndustryGroups }, nil?: true
|
|
255
|
-
|
|
256
|
-
# @!attribute industry_type
|
|
257
|
-
# The different industry types a company can be in.
|
|
258
|
-
#
|
|
259
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
260
|
-
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
261
|
-
|
|
262
244
|
# @!attribute product_tax_code_id
|
|
263
245
|
# The ID of the product tax code to apply to this product.
|
|
264
246
|
#
|
|
@@ -283,7 +265,7 @@ module WhopSDK
|
|
|
283
265
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
284
266
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
285
267
|
|
|
286
|
-
# @!method initialize(external_identifier:, title:,
|
|
268
|
+
# @!method initialize(external_identifier:, title:, collect_shipping_address: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil)
|
|
287
269
|
# Some parameter documentations has been truncated, see
|
|
288
270
|
# {WhopSDK::Models::PaymentCreateParams::Plan::Product} for more details.
|
|
289
271
|
#
|
|
@@ -294,8 +276,6 @@ module WhopSDK
|
|
|
294
276
|
#
|
|
295
277
|
# @param title [String] The title of the product.
|
|
296
278
|
#
|
|
297
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
298
|
-
#
|
|
299
279
|
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
300
280
|
#
|
|
301
281
|
# @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
|
|
@@ -309,10 +289,6 @@ module WhopSDK
|
|
|
309
289
|
#
|
|
310
290
|
# @param headline [String, nil] The headline of the product.
|
|
311
291
|
#
|
|
312
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
313
|
-
#
|
|
314
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
315
|
-
#
|
|
316
292
|
# @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
|
|
317
293
|
#
|
|
318
294
|
# @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
|
|
@@ -9,12 +9,6 @@ module WhopSDK
|
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
11
11
|
|
|
12
|
-
# @!attribute business_type
|
|
13
|
-
# The different business types a company can be.
|
|
14
|
-
#
|
|
15
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
16
|
-
required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
17
|
-
|
|
18
12
|
# @!attribute company
|
|
19
13
|
# The company this product belongs to.
|
|
20
14
|
#
|
|
@@ -90,12 +84,6 @@ module WhopSDK
|
|
|
90
84
|
# @return [String, nil]
|
|
91
85
|
required :headline, String, nil?: true
|
|
92
86
|
|
|
93
|
-
# @!attribute industry_type
|
|
94
|
-
# The different industry types a company can be in.
|
|
95
|
-
#
|
|
96
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
97
|
-
required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
98
|
-
|
|
99
87
|
# @!attribute member_affiliate_percentage
|
|
100
88
|
# The commission rate (as a percentage) that existing members earn when referring
|
|
101
89
|
# new customers through the member affiliate program. Null if the program is not
|
|
@@ -169,7 +157,7 @@ module WhopSDK
|
|
|
169
157
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
170
158
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
171
159
|
|
|
172
|
-
# @!method initialize(id:,
|
|
160
|
+
# @!method initialize(id:, company:, created_at:, custom_cta:, custom_cta_url:, custom_statement_descriptor:, description:, external_identifier:, gallery_images:, global_affiliate_percentage:, global_affiliate_status:, headline:, member_affiliate_percentage:, member_affiliate_status:, member_count:, owner_user:, product_tax_code:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
173
161
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
|
|
174
162
|
# for more details.
|
|
175
163
|
#
|
|
@@ -178,8 +166,6 @@ module WhopSDK
|
|
|
178
166
|
#
|
|
179
167
|
# @param id [String] The unique identifier for the product.
|
|
180
168
|
#
|
|
181
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
182
|
-
#
|
|
183
169
|
# @param company [WhopSDK::Models::Product::Company] The company this product belongs to.
|
|
184
170
|
#
|
|
185
171
|
# @param created_at [Time] The datetime the product was created.
|
|
@@ -202,8 +188,6 @@ module WhopSDK
|
|
|
202
188
|
#
|
|
203
189
|
# @param headline [String, nil] A short marketing headline displayed prominently on the product's product page.
|
|
204
190
|
#
|
|
205
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
206
|
-
#
|
|
207
191
|
# @param member_affiliate_percentage [Float, nil] The commission rate (as a percentage) that existing members earn when referring
|
|
208
192
|
#
|
|
209
193
|
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus] The enrollment status of this product in the member affiliate program.
|
|
@@ -19,12 +19,6 @@ module WhopSDK
|
|
|
19
19
|
# @return [String]
|
|
20
20
|
required :title, String
|
|
21
21
|
|
|
22
|
-
# @!attribute business_type
|
|
23
|
-
# The different business types a company can be.
|
|
24
|
-
#
|
|
25
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
26
|
-
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
27
|
-
|
|
28
22
|
# @!attribute collect_shipping_address
|
|
29
23
|
# Whether the checkout flow collects a shipping address from the customer.
|
|
30
24
|
#
|
|
@@ -83,18 +77,6 @@ module WhopSDK
|
|
|
83
77
|
# @return [String, nil]
|
|
84
78
|
optional :headline, String, nil?: true
|
|
85
79
|
|
|
86
|
-
# @!attribute industry_group
|
|
87
|
-
# The different industry groups a company can be in.
|
|
88
|
-
#
|
|
89
|
-
# @return [Symbol, WhopSDK::Models::IndustryGroups, nil]
|
|
90
|
-
optional :industry_group, enum: -> { WhopSDK::IndustryGroups }, nil?: true
|
|
91
|
-
|
|
92
|
-
# @!attribute industry_type
|
|
93
|
-
# The different industry types a company can be in.
|
|
94
|
-
#
|
|
95
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
96
|
-
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
97
|
-
|
|
98
80
|
# @!attribute member_affiliate_percentage
|
|
99
81
|
# The commission rate as a percentage that members earn through the member
|
|
100
82
|
# affiliate program.
|
|
@@ -138,7 +120,7 @@ module WhopSDK
|
|
|
138
120
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
139
121
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
140
122
|
|
|
141
|
-
# @!method initialize(company_id:, title:,
|
|
123
|
+
# @!method initialize(company_id:, title:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, plan_options: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil, request_options: {})
|
|
142
124
|
# Some parameter documentations has been truncated, see
|
|
143
125
|
# {WhopSDK::Models::ProductCreateParams} for more details.
|
|
144
126
|
#
|
|
@@ -146,8 +128,6 @@ module WhopSDK
|
|
|
146
128
|
#
|
|
147
129
|
# @param title [String] The display name of the product. Maximum 40 characters.
|
|
148
130
|
#
|
|
149
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
150
|
-
#
|
|
151
131
|
# @param collect_shipping_address [Boolean, nil] Whether the checkout flow collects a shipping address from the customer.
|
|
152
132
|
#
|
|
153
133
|
# @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
|
|
@@ -166,10 +146,6 @@ module WhopSDK
|
|
|
166
146
|
#
|
|
167
147
|
# @param headline [String, nil] A short marketing headline displayed prominently on the product page.
|
|
168
148
|
#
|
|
169
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
170
|
-
#
|
|
171
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
172
|
-
#
|
|
173
149
|
# @param member_affiliate_percentage [Float, nil] The commission rate as a percentage that members earn through the member affilia
|
|
174
150
|
#
|
|
175
151
|
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
@@ -9,12 +9,6 @@ module WhopSDK
|
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
11
11
|
|
|
12
|
-
# @!attribute business_type
|
|
13
|
-
# The different business types a company can be.
|
|
14
|
-
#
|
|
15
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
16
|
-
required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
17
|
-
|
|
18
12
|
# @!attribute created_at
|
|
19
13
|
# The datetime the product was created.
|
|
20
14
|
#
|
|
@@ -35,12 +29,6 @@ module WhopSDK
|
|
|
35
29
|
# @return [String, nil]
|
|
36
30
|
required :headline, String, nil?: true
|
|
37
31
|
|
|
38
|
-
# @!attribute industry_type
|
|
39
|
-
# The different industry types a company can be in.
|
|
40
|
-
#
|
|
41
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
42
|
-
required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
43
|
-
|
|
44
32
|
# @!attribute member_count
|
|
45
33
|
# The number of users who currently hold an active membership to this product.
|
|
46
34
|
# Returns 0 if the company has disabled public member counts.
|
|
@@ -87,7 +75,7 @@ module WhopSDK
|
|
|
87
75
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
88
76
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
89
77
|
|
|
90
|
-
# @!method initialize(id:,
|
|
78
|
+
# @!method initialize(id:, created_at:, external_identifier:, headline:, member_count:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
91
79
|
# Some parameter documentations has been truncated, see
|
|
92
80
|
# {WhopSDK::Models::ProductListItem} for more details.
|
|
93
81
|
#
|
|
@@ -96,16 +84,12 @@ module WhopSDK
|
|
|
96
84
|
#
|
|
97
85
|
# @param id [String] The unique identifier for the product.
|
|
98
86
|
#
|
|
99
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
100
|
-
#
|
|
101
87
|
# @param created_at [Time] The datetime the product was created.
|
|
102
88
|
#
|
|
103
89
|
# @param external_identifier [String, nil] A unique identifier used to create or update products via the API. When provided
|
|
104
90
|
#
|
|
105
91
|
# @param headline [String, nil] A short marketing headline displayed prominently on the product's product page.
|
|
106
92
|
#
|
|
107
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
108
|
-
#
|
|
109
93
|
# @param member_count [Integer] The number of users who currently hold an active membership to this product. Ret
|
|
110
94
|
#
|
|
111
95
|
# @param published_reviews_count [Integer] The total number of published customer reviews for this product's company.
|
|
@@ -7,12 +7,6 @@ module WhopSDK
|
|
|
7
7
|
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include WhopSDK::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute business_type
|
|
11
|
-
# The different business types a company can be.
|
|
12
|
-
#
|
|
13
|
-
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
14
|
-
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
15
|
-
|
|
16
10
|
# @!attribute collect_shipping_address
|
|
17
11
|
# Whether the checkout flow collects a shipping address from the customer.
|
|
18
12
|
#
|
|
@@ -73,18 +67,6 @@ module WhopSDK
|
|
|
73
67
|
# @return [String, nil]
|
|
74
68
|
optional :headline, String, nil?: true
|
|
75
69
|
|
|
76
|
-
# @!attribute industry_group
|
|
77
|
-
# The different industry groups a company can be in.
|
|
78
|
-
#
|
|
79
|
-
# @return [Symbol, WhopSDK::Models::IndustryGroups, nil]
|
|
80
|
-
optional :industry_group, enum: -> { WhopSDK::IndustryGroups }, nil?: true
|
|
81
|
-
|
|
82
|
-
# @!attribute industry_type
|
|
83
|
-
# The different industry types a company can be in.
|
|
84
|
-
#
|
|
85
|
-
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
86
|
-
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
87
|
-
|
|
88
70
|
# @!attribute member_affiliate_percentage
|
|
89
71
|
# The commission rate as a percentage that members earn through the member
|
|
90
72
|
# affiliate program.
|
|
@@ -134,12 +116,10 @@ module WhopSDK
|
|
|
134
116
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
135
117
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
136
118
|
|
|
137
|
-
# @!method initialize(
|
|
119
|
+
# @!method initialize(collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, gallery_images: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
|
|
138
120
|
# Some parameter documentations has been truncated, see
|
|
139
121
|
# {WhopSDK::Models::ProductUpdateParams} for more details.
|
|
140
122
|
#
|
|
141
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
142
|
-
#
|
|
143
123
|
# @param collect_shipping_address [Boolean, nil] Whether the checkout flow collects a shipping address from the customer.
|
|
144
124
|
#
|
|
145
125
|
# @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
|
|
@@ -158,10 +138,6 @@ module WhopSDK
|
|
|
158
138
|
#
|
|
159
139
|
# @param headline [String, nil] A short marketing headline displayed prominently on the product page.
|
|
160
140
|
#
|
|
161
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
162
|
-
#
|
|
163
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
164
|
-
#
|
|
165
141
|
# @param member_affiliate_percentage [Float, nil] The commission rate as a percentage that members earn through the member affilia
|
|
166
142
|
#
|
|
167
143
|
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
data/lib/whop_sdk/models.rb
CHANGED
|
@@ -101,8 +101,6 @@ module WhopSDK
|
|
|
101
101
|
|
|
102
102
|
BillingReasons = WhopSDK::Models::BillingReasons
|
|
103
103
|
|
|
104
|
-
BusinessTypes = WhopSDK::Models::BusinessTypes
|
|
105
|
-
|
|
106
104
|
CancelOptions = WhopSDK::Models::CancelOptions
|
|
107
105
|
|
|
108
106
|
CardBrands = WhopSDK::Models::CardBrands
|
|
@@ -342,10 +340,6 @@ module WhopSDK
|
|
|
342
340
|
|
|
343
341
|
GlobalAffiliateStatus = WhopSDK::Models::GlobalAffiliateStatus
|
|
344
342
|
|
|
345
|
-
IndustryGroups = WhopSDK::Models::IndustryGroups
|
|
346
|
-
|
|
347
|
-
IndustryTypes = WhopSDK::Models::IndustryTypes
|
|
348
|
-
|
|
349
343
|
Invoice = WhopSDK::Models::Invoice
|
|
350
344
|
|
|
351
345
|
InvoiceCreatedWebhookEvent = WhopSDK::Models::InvoiceCreatedWebhookEvent
|
|
@@ -14,20 +14,14 @@ module WhopSDK
|
|
|
14
14
|
# - `company:create`
|
|
15
15
|
# - `company:basic:read`
|
|
16
16
|
#
|
|
17
|
-
# @overload create(title:,
|
|
17
|
+
# @overload create(title:, description: nil, email: nil, logo: nil, metadata: nil, parent_company_id: nil, send_customer_emails: nil, request_options: {})
|
|
18
18
|
#
|
|
19
19
|
# @param title [String] The display name of the company shown to customers.
|
|
20
20
|
#
|
|
21
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
22
|
-
#
|
|
23
21
|
# @param description [String, nil] A promotional pitch displayed to potential customers on the company's store page
|
|
24
22
|
#
|
|
25
23
|
# @param email [String, nil] The email address of the user who will own the connected account. Required when
|
|
26
24
|
#
|
|
27
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
28
|
-
#
|
|
29
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
30
|
-
#
|
|
31
25
|
# @param logo [WhopSDK::Models::CompanyCreateParams::Logo, nil] The company's logo image. Accepts PNG, JPEG, or GIF format.
|
|
32
26
|
#
|
|
33
27
|
# @param metadata [Hash{Symbol=>Object}, nil] A key-value JSON object of custom metadata to store on the company.
|
|
@@ -86,20 +80,14 @@ module WhopSDK
|
|
|
86
80
|
# - `company:update`
|
|
87
81
|
# - `company:basic:read`
|
|
88
82
|
#
|
|
89
|
-
# @overload update(id, banner_image: nil,
|
|
83
|
+
# @overload update(id, banner_image: nil, description: nil, logo: nil, route: nil, send_customer_emails: nil, target_audience: nil, title: nil, request_options: {})
|
|
90
84
|
#
|
|
91
85
|
# @param id [String] The unique identifier of the company to update.
|
|
92
86
|
#
|
|
93
87
|
# @param banner_image [WhopSDK::Models::CompanyUpdateParams::BannerImage, nil] The company's banner image. Accepts PNG or JPEG format.
|
|
94
88
|
#
|
|
95
|
-
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
96
|
-
#
|
|
97
89
|
# @param description [String, nil] A promotional pitch displayed to potential customers on the company's store page
|
|
98
90
|
#
|
|
99
|
-
# @param industry_group [Symbol, WhopSDK::Models::IndustryGroups, nil] The different industry groups a company can be in.
|
|
100
|
-
#
|
|
101
|
-
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
102
|
-
#
|
|
103
91
|
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo, nil] The company's logo image. Accepts PNG, JPEG, or GIF format.
|
|
104
92
|
#
|
|
105
93
|
# @param route [String, nil] The unique URL slug for the company's store page. Must be lowercase and can incl
|