Class: WhopSDK::Models::Company

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/company.rb

Defined Under Namespace

Classes: FeaturedAffiliateProduct, Logo, OwnerUser, SocialLink

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, name:, username:) ⇒ Object

The user who owns and has full administrative control over this company.

Parameters:

  • id (String) —

    The unique identifier for the user.

  • name (String, nil) —

    The user’s display name shown on their public profile.

  • username (String) —

    The user’s unique username shown on their public profile.




# File 'lib/whop_sdk/models/company.rb', line 116

Instance Attribute Details

#affiliate_instructions ⇒ String?

Guidelines and instructions provided to affiliates explaining how to promote this company’s products.

Returns:

  • (String, nil) 


17
 
# File 'lib/whop_sdk/models/company.rb', line 17

required :affiliate_instructions, String, nil?: true

#created_at ⇒ Time

The datetime the company was created.

Returns:

  • (Time) 


23
 
# File 'lib/whop_sdk/models/company.rb', line 23

required :created_at, Time

#description ⇒ String?

A promotional pitch written by the company creator, displayed to potential customers on the store page.

Returns:

  • (String, nil) 


30
 
# File 'lib/whop_sdk/models/company.rb', line 30

required :description, String, nil?: true

#featured_affiliate_product ⇒ WhopSDK::Models::Company::FeaturedAffiliateProduct?

The product featured for affiliates to promote on this company’s affiliate page. Null if none is configured.

Returns:



37
 
# File 'lib/whop_sdk/models/company.rb', line 37

required :featured_affiliate_product, -> { WhopSDK::Company::FeaturedAffiliateProduct }, nil?: true

#id ⇒ String

The unique identifier for the company.

Returns:

  • (String) 


10
 
# File 'lib/whop_sdk/models/company.rb', line 10

required :id, String

#logo ⇒ WhopSDK::Models::Company::Logo?

The company’s logo.

Returns:



43
 
# File 'lib/whop_sdk/models/company.rb', line 43

required :logo, -> { WhopSDK::Company::Logo }, nil?: true

#member_count ⇒ Integer

The total number of users who currently hold active memberships across all of this company’s products.

Returns:

  • (Integer) 


50
 
# File 'lib/whop_sdk/models/company.rb', line 50

required :member_count, Integer

#metadata ⇒ Hash{Symbol=>Object}?

A key-value JSON object of custom metadata for this company, managed by the platform that created the account.

Returns:

  • (Hash{Symbol=>Object}, nil) 


57
 
# File 'lib/whop_sdk/models/company.rb', line 57

required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true

#owner_user ⇒ WhopSDK::Models::Company::OwnerUser

The user who owns and has full administrative control over this company.

Returns:



63
 
# File 'lib/whop_sdk/models/company.rb', line 63

required :owner_user, -> { WhopSDK::Company::OwnerUser }

#published_reviews_count ⇒ Integer

The total number of published customer reviews across all products for this company.

Returns:

  • (Integer) 


70
 
# File 'lib/whop_sdk/models/company.rb', line 70

required :published_reviews_count, Integer

#route ⇒ String

The URL slug for the company’s store page (e.g., ‘pickaxe’ in whop.com/pickaxe).

Returns:

  • (String) 


76
 
# File 'lib/whop_sdk/models/company.rb', line 76

required :route, String

#send_customer_emails ⇒ Boolean

Whether Whop sends transactional emails (receipts, updates) to customers on behalf of this company.

Returns:

  • (Boolean) 


83
 
# File 'lib/whop_sdk/models/company.rb', line 83

required :send_customer_emails, WhopSDK::Internal::Type::Boolean

#social_links ⇒ Array<WhopSDK::Models::Company::SocialLink>

The list of social media accounts and external links associated with this company.

Returns:



90
 
# File 'lib/whop_sdk/models/company.rb', line 90

required :social_links, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Company::SocialLink] }

#target_audience ⇒ String?

The target audience for the company. Null if not set.

Returns:

  • (String, nil) 


96
 
# File 'lib/whop_sdk/models/company.rb', line 96

required :target_audience, String, nil?: true

#title ⇒ String

The display name of the company shown to customers.

Returns:

  • (String) 


102
 
# File 'lib/whop_sdk/models/company.rb', line 102

required :title, String

#updated_at ⇒ Time

The datetime the company was last updated.

Returns:

  • (Time) 


108
 
# File 'lib/whop_sdk/models/company.rb', line 108

required :updated_at, Time

#verified ⇒ Boolean

Whether this company has been verified by Whop’s trust and safety team.

Returns:

  • (Boolean) 


114
 
# File 'lib/whop_sdk/models/company.rb', line 114

required :verified, WhopSDK::Internal::Type::Boolean