Class: WhopSDK::Models::ProductUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::ProductUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/product_update_params.rb

Overview

See Also:

• Resources::Products#update

Defined Under Namespace

Classes: GalleryImage, StorePageConfig

Instance Attribute Summary

• #collect_shipping_address ⇒ Boolean^?

  Whether the checkout flow collects a shipping address from the customer.

• #custom_cta ⇒ Symbol, ...

  The different types of custom CTAs that can be selected.

• #custom_cta_url ⇒ String^?

  A URL that the call-to-action button links to instead of the default checkout flow.

• #custom_statement_descriptor ⇒ String^?

  A custom text label that appears on the customer’s bank statement.

• #description ⇒ String^?

  A written description of the product displayed on its product page.

• #gallery_images ⇒ Array<WhopSDK::Models::ProductUpdateParams::GalleryImage>^?

  The gallery images for the product.

• #global_affiliate_percentage ⇒ Float^?

  The commission rate as a percentage that affiliates earn through the global affiliate program.

• #global_affiliate_status ⇒ Symbol, ...

  The different statuses of the global affiliate program for a product.

• #headline ⇒ String^?

  A short marketing headline displayed prominently on the product page.

• #id ⇒ String
• #member_affiliate_percentage ⇒ Float^?

  The commission rate as a percentage that members earn through the member affiliate program.

• #member_affiliate_status ⇒ Symbol, ...

  The different statuses of the global affiliate program for a product.

• #product_tax_code_id ⇒ String^?

  The unique identifier of the tax classification code to apply to this product.

• #redirect_purchase_url ⇒ String^?

  A URL to redirect the customer to after completing a purchase.

• #route ⇒ String^?

  The URL slug for the product’s public link.

• #send_welcome_message ⇒ Boolean^?

  Whether to send an automated welcome message via support chat when a user joins this product.

• #store_page_config ⇒ WhopSDK::Models::ProductUpdateParams::StorePageConfig^?

  Layout and display configuration for this product on the company’s store page.

• #title ⇒ String^?

  The display name of the product.

• #visibility ⇒ Symbol, ...

  Visibility of a resource.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:) ⇒ Object constructor

  Input for an attachment.

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

Input for an attachment

Parameters:

• id (String) —

  The ID of an existing file object.

# File 'lib/whop_sdk/models/product_update_params.rb', line 182

Instance Attribute Details

#collect_shipping_address ⇒ Boolean^?

Whether the checkout flow collects a shipping address from the customer.

Returns:

• (Boolean, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 19

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

#custom_cta ⇒ Symbol, ...

The different types of custom CTAs that can be selected.

Returns:

• (Symbol, WhopSDK::Models::CustomCta, nil)

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

optional :custom_cta, enum: -> { WhopSDK::CustomCta }, nil?: true

#custom_cta_url ⇒ String^?

A URL that the call-to-action button links to instead of the default checkout flow.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 32

optional :custom_cta_url, String, nil?: true

#custom_statement_descriptor ⇒ String^?

A custom text label that appears on the customer’s bank statement. Must be 5-22 characters, contain at least one letter, and not contain <, >, , ‘, or “ characters.

Returns:

• (String, nil)

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

optional :custom_statement_descriptor, String, nil?: true

#description ⇒ String^?

A written description of the product displayed on its product page.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 46

optional :description, String, nil?: true

#gallery_images ⇒ Array<WhopSDK::Models::ProductUpdateParams::GalleryImage>^?

The gallery images for the product.

Returns:

• (Array<WhopSDK::Models::ProductUpdateParams::GalleryImage>, nil)

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

optional :gallery_images,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductUpdateParams::GalleryImage] },
nil?: true

#global_affiliate_percentage ⇒ Float^?

The commission rate as a percentage that affiliates earn through the global affiliate program.

Returns:

• (Float, nil)

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

optional :global_affiliate_percentage, Float, nil?: true

#global_affiliate_status ⇒ Symbol, ...

The different statuses of the global affiliate program for a product.

Returns:

• (Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil)

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

optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true

#headline ⇒ String^?

A short marketing headline displayed prominently on the product page.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 73

optional :headline, String, nil?: true

#id ⇒ String

Returns:

• (String)

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

required :id, String

#member_affiliate_percentage ⇒ Float^?

The commission rate as a percentage that members earn through the member affiliate program.

Returns:

• (Float, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 80

optional :member_affiliate_percentage, Float, nil?: true

#member_affiliate_status ⇒ Symbol, ...

The different statuses of the global affiliate program for a product.

Returns:

• (Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 86

optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true

#product_tax_code_id ⇒ String^?

The unique identifier of the tax classification code to apply to this product.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 92

optional :product_tax_code_id, String, nil?: true

#redirect_purchase_url ⇒ String^?

A URL to redirect the customer to after completing a purchase.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 98

optional :redirect_purchase_url, String, nil?: true

#route ⇒ String^?

The URL slug for the product’s public link.

Returns:

• (String, nil)

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

optional :route, String, nil?: true

#send_welcome_message ⇒ Boolean^?

Whether to send an automated welcome message via support chat when a user joins this product.

Returns:

• (Boolean, nil)

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

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

#store_page_config ⇒ WhopSDK::Models::ProductUpdateParams::StorePageConfig^?

Layout and display configuration for this product on the company’s store page.

Returns:

• (WhopSDK::Models::ProductUpdateParams::StorePageConfig, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 117

optional :store_page_config, -> { WhopSDK::ProductUpdateParams::StorePageConfig }, nil?: true

#title ⇒ String^?

The display name of the product. Maximum 80 characters.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/product_update_params.rb', line 123

optional :title, String, nil?: true

#visibility ⇒ Symbol, ...

Visibility of a resource

Returns:

• (Symbol, WhopSDK::Models::Visibility, nil)

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

optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true