Class: WhopSDK::Models::CompanyCreateParams

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

Overview

See Also:

Defined Under Namespace

Classes: Logo

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#description ⇒ String?

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

Returns:

  • (String, nil) 


21
 
# File 'lib/whop_sdk/models/company_create_params.rb', line 21

optional :description, String, nil?: true

#email ⇒ String?

The email address of the user who will own the connected account. Required when parent_company_id is provided.

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

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

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

Returns:



34
 
# File 'lib/whop_sdk/models/company_create_params.rb', line 34

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

#metadata ⇒ Hash{Symbol=>Object}?

A key-value JSON object of custom metadata to store on the company.

Returns:

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


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

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

#parent_company_id ⇒ String?

The unique identifier of the parent platform company. When provided, creates a connected account under that platform. Omit to create a company for the current user.

Returns:

  • (String, nil) 


48
 
# File 'lib/whop_sdk/models/company_create_params.rb', line 48

optional :parent_company_id, String, nil?: true

#send_customer_emails ⇒ Boolean?

Whether Whop sends transactional emails to customers on behalf of this company. Only applies when creating a connected account.

Returns:

  • (Boolean, nil) 


55
 
# File 'lib/whop_sdk/models/company_create_params.rb', line 55

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

#title ⇒ String

The display name of the company shown to customers.

Returns:

  • (String) 


14
 
# File 'lib/whop_sdk/models/company_create_params.rb', line 14

required :title, String