Class: WhopSDK::Models::AppListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/app_list_response.rb,
sig/whop_sdk/models/app_list_response.rbs

Overview

See Also:

  • WhopSDK::Resources::Apps#list

Defined Under Namespace

Classes: Company, Creator, Icon

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 created and owns the company that published this app.

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/app_list_response.rb', line 143

Instance Attribute Details

#app_type ⇒ Symbol, WhopSDK::Models::AppType

The target audience classification for this app (e.g., 'b2b_app', 'b2c_app', 'company_app', 'component').

Parameters:

  • value (WhopSDK::Models::app_type)

Returns:



18
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 18

required :app_type, enum: -> { WhopSDK::AppType }

#base_url ⇒ String?

The production base URL where the app is hosted. Null if no base URL is configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


25
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 25

required :base_url, String, nil?: true

#company ⇒ WhopSDK::Models::AppListResponse::Company

The company that owns and publishes this app.

Parameters:

Returns:



31
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 31

required :company, -> { WhopSDK::Models::AppListResponse::Company }

#creator ⇒ WhopSDK::Models::AppListResponse::Creator

The user who created and owns the company that published this app.

Parameters:

Returns:



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

required :creator, -> { WhopSDK::Models::AppListResponse::Creator }

#dashboard_path ⇒ String?

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


45
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 45

required :dashboard_path, String, nil?: true

#description ⇒ String?

A written description of what this app does, displayed on the app store listing page. Null if no description has been set.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


52
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 52

required :description, String, nil?: true

#discover_path ⇒ String?

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


60
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 60

required :discover_path, String, nil?: true

#domain_id ⇒ String

The unique subdomain identifier for this app's proxied URL on the Whop platform. Forms the URL pattern #domain_id.apps.whop.com">https://#domain_id.apps.whop.com.

Parameters:

  • value (String)

Returns:

  • (String) 


67
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 67

required :domain_id, String

#experience_path ⇒ String?

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


75
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 75

required :experience_path, String, nil?: true

#hosted_url ⇒ String?

The full canonical URL where this app's hosted web build is served. Null if the app has not claimed a route.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


82
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 82

required :hosted_url, String, nil?: true

#icon ⇒ WhopSDK::Models::AppListResponse::Icon?

The icon image for this app, displayed on the app store, product pages, checkout, and as the default icon for experiences using this app.

Parameters:

Returns:



89
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 89

required :icon, -> { WhopSDK::Models::AppListResponse::Icon }, nil?: true

#id ⇒ String

The unique identifier for the app.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 11

required :id, String

#name ⇒ String

The display name of this app shown on the app store and in experience navigation. Maximum 30 characters.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#openapi_path ⇒ String?

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


104
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 104

required :openapi_path, String, nil?: true

#origin ⇒ String?

The full origin URL for this app's proxied domain (e.g., 'https://myapp.apps.whop.com'). Null if no proxy domain is configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


111
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 111

required :origin, String, nil?: true

#route ⇒ String?

The unique subdomain route where this app's hosted web builds are served, such as 'myapp' for myapp.whop.app. Null if the app has not claimed a route.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


118
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 118

required :route, String, nil?: true

#skills_path ⇒ String?

The URL path template for a specific view of this app, appended to the base domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is not configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


126
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 126

required :skills_path, String, nil?: true

#status ⇒ Symbol, WhopSDK::Models::AppStatuses

The current visibility status of this app on the Whop app store. 'live' means publicly discoverable, 'unlisted' means accessible only via direct link, and 'hidden' means not visible anywhere.

Parameters:

  • value (WhopSDK::Models::app_statuses)

Returns:



134
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 134

required :status, enum: -> { WhopSDK::AppStatuses }

#verified ⇒ Boolean

Whether this app has been verified by Whop. Verified apps are endorsed by Whop and displayed in the featured apps section of the app store.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


141
 
# File 'lib/whop_sdk/models/app_list_response.rb', line 141

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


87
 
# File 'sig/whop_sdk/models/app_list_response.rbs', line 87

def to_hash: -> {