Class: WhopSDK::Models::CompanyUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/company_update_params.rb,
sig/whop_sdk/models/company_update_params.rbs

Overview

See Also:

  • WhopSDK::Resources::Companies#update

Defined Under Namespace

Classes: BannerImage, Logo, SocialLink

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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

The company's logo image. Accepts PNG, JPEG, or GIF format.

Parameters:

  • id (String) —

    The ID of an existing file object.




# File 'lib/whop_sdk/models/company_update_params.rb', line 129

Instance Attribute Details

#affiliate_application_required ⇒ Boolean?

Whether prospective affiliates must submit an application before they can promote this company.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 20

optional :affiliate_application_required, WhopSDK::Internal::Type::Boolean, nil?: true

#affiliate_instructions ⇒ String?

Guidelines and instructions shown to affiliates explaining how to promote this company's products.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


27
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 27

optional :affiliate_instructions, String, nil?: true

The company's banner image. Accepts PNG or JPEG format.

Parameters:

  • value (WhopSDK::CompanyUpdateParams::BannerImage, nil)

Returns:



33
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 33

optional :banner_image, -> { WhopSDK::CompanyUpdateParams::BannerImage }, nil?: true

#description ⇒ String?

A promotional pitch displayed to potential customers on the company's store page.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


40
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 40

optional :description, String, nil?: true

#featured_affiliate_product_id ⇒ String?

The ID of the product to feature on this company's affiliate page. Pass null to clear.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


47
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 47

optional :featured_affiliate_product_id, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 13

required :id, String

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

The company's logo image. Accepts PNG, JPEG, or GIF format.

Parameters:

  • value (WhopSDK::CompanyUpdateParams::Logo, nil)

Returns:



53
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 53

optional :logo, -> { WhopSDK::CompanyUpdateParams::Logo }, nil?: true

#route ⇒ String?

The unique URL slug for the company's store page. Must be lowercase and can include hyphens (e.g., 'my-company'). If not provided, the route will remain unchanged.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 61

optional :route, String, nil?: true

#send_customer_emails ⇒ Boolean?

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

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


68
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 68

optional :send_customer_emails, WhopSDK::Internal::Type::Boolean, nil?: true

#social_links ⇒ Array<WhopSDK::Models::CompanyUpdateParams::SocialLink>?

The social media links to display on the company's store page. Pass the full list of desired social links — any existing links not included will be removed.

Parameters:

  • value (::Array[WhopSDK::CompanyUpdateParams::SocialLink], nil)

Returns:



75
76
77
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 75

optional :social_links,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CompanyUpdateParams::SocialLink] },
nil?: true

#target_audience ⇒ String?

The target audience for this company (e.g., 'beginner day traders aged 18-25 looking to learn options').

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


84
 
# File 'lib/whop_sdk/models/company_update_params.rb', line 84

optional :target_audience, String, nil?: true

#title ⇒ String?

The display name of the company shown to customers.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :title, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


64
 
# File 'sig/whop_sdk/models/company_update_params.rbs', line 64

def to_hash: -> {