Class: WhopSDK::Models::Experience

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

Defined Under Namespace

Classes: App, Company, Image, Product

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(url:) ⇒ Object

Some parameter documentations has been truncated, see Image for more details.

The custom logo image for this experience. Null if no custom logo has been uploaded.

Parameters:

  • url (String, nil) —

    A pre-optimized URL for rendering this attachment on the client. This should be




# File 'lib/whop_sdk/models/experience.rb', line 66

Instance Attribute Details

#app ⇒ WhopSDK::Models::Experience::App

The app that powers this experience, defining its interface and behavior.

Returns:



16
 
# File 'lib/whop_sdk/models/experience.rb', line 16

required :app, -> { WhopSDK::Experience::App }

#company ⇒ WhopSDK::Models::Experience::Company

The company that owns this experience.

Returns:



22
 
# File 'lib/whop_sdk/models/experience.rb', line 22

required :company, -> { WhopSDK::Experience::Company }

#created_at ⇒ Time

The datetime the experience was created.

Returns:

  • (Time) 


28
 
# File 'lib/whop_sdk/models/experience.rb', line 28

required :created_at, Time

#id ⇒ String

The unique identifier for the experience.

Returns:

  • (String) 


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

required :id, String

#image ⇒ WhopSDK::Models::Experience::Image?

The custom logo image for this experience. Null if no custom logo has been uploaded.

Returns:



35
 
# File 'lib/whop_sdk/models/experience.rb', line 35

required :image, -> { WhopSDK::Experience::Image }, nil?: true

#is_public ⇒ Boolean

Whether this experience is publicly visible to all users, including those without a membership.

Returns:

  • (Boolean) 


42
 
# File 'lib/whop_sdk/models/experience.rb', line 42

required :is_public, WhopSDK::Internal::Type::Boolean

#name ⇒ String

The display name of this experience shown to users in the product navigation. Maximum 255 characters.

Returns:

  • (String) 


49
 
# File 'lib/whop_sdk/models/experience.rb', line 49

required :name, String

#order ⇒ String?

The sort position of this experience within its section. Lower values appear first. Null if no position has been set.

Returns:

  • (String, nil) 


56
 
# File 'lib/whop_sdk/models/experience.rb', line 56

required :order, String, nil?: true

#products ⇒ Array<WhopSDK::Models::Experience::Product>

The list of products this experience is attached to, which determines which customers have access. Empty if the experience is only visible to authorized company team members.

Returns:



64
 
# File 'lib/whop_sdk/models/experience.rb', line 64

required :products, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Experience::Product] }